@supernova-studio/client 0.59.12 → 1.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (204) hide show
  1. package/dist/index.d.mts +1592 -1952
  2. package/dist/index.d.ts +1592 -1952
  3. package/dist/index.js +865 -392
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +2569 -2096
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +4 -3
  8. package/src/api/client.ts +0 -31
  9. package/src/api/conversion/documentation/documentation-group-v1-to-dto.ts +0 -114
  10. package/src/api/conversion/documentation/documentation-group-v2-to-dto.ts +0 -92
  11. package/src/api/conversion/documentation/documentation-item-configuration-v1-to-dto.ts +0 -52
  12. package/src/api/conversion/documentation/documentation-item-configuration-v2-to-dto.ts +0 -34
  13. package/src/api/conversion/documentation/documentation-page-to-dto-utils.ts +0 -131
  14. package/src/api/conversion/documentation/documentation-page-v1-to-dto.ts +0 -69
  15. package/src/api/conversion/documentation/documentation-page-v2-to-dto.ts +0 -78
  16. package/src/api/conversion/documentation/index.ts +0 -7
  17. package/src/api/conversion/export/index.ts +0 -1
  18. package/src/api/conversion/export/pipeline.ts +0 -26
  19. package/src/api/conversion/index.ts +0 -3
  20. package/src/api/conversion/integrations/git.ts +0 -37
  21. package/src/api/conversion/integrations/index.ts +0 -2
  22. package/src/api/conversion/integrations/integration.ts +0 -37
  23. package/src/api/dto/aux/color.ts +0 -7
  24. package/src/api/dto/aux/index.ts +0 -3
  25. package/src/api/dto/aux/meta.ts +0 -8
  26. package/src/api/dto/aux/pagination.ts +0 -8
  27. package/src/api/dto/bff/app-bootstrap-data.ts +0 -20
  28. package/src/api/dto/bff/index.ts +0 -1
  29. package/src/api/dto/collections/index.ts +0 -1
  30. package/src/api/dto/collections/token-collection.ts +0 -24
  31. package/src/api/dto/design-systems/brand.ts +0 -44
  32. package/src/api/dto/design-systems/component.ts +0 -40
  33. package/src/api/dto/design-systems/contact.ts +0 -11
  34. package/src/api/dto/design-systems/data-source.ts +0 -141
  35. package/src/api/dto/design-systems/design-system.ts +0 -68
  36. package/src/api/dto/design-systems/elements-diff.ts +0 -14
  37. package/src/api/dto/design-systems/figma-variables.ts +0 -108
  38. package/src/api/dto/design-systems/import-job.ts +0 -61
  39. package/src/api/dto/design-systems/index.ts +0 -15
  40. package/src/api/dto/design-systems/members.ts +0 -50
  41. package/src/api/dto/design-systems/redirects.ts +0 -33
  42. package/src/api/dto/design-systems/role.ts +0 -11
  43. package/src/api/dto/design-systems/stats.ts +0 -19
  44. package/src/api/dto/design-systems/version-room.ts +0 -12
  45. package/src/api/dto/design-systems/version.ts +0 -56
  46. package/src/api/dto/design-systems/view.ts +0 -45
  47. package/src/api/dto/design-tokens/design-token.ts +0 -78
  48. package/src/api/dto/design-tokens/index.ts +0 -1
  49. package/src/api/dto/documentation/anchor.ts +0 -15
  50. package/src/api/dto/documentation/approvals.ts +0 -15
  51. package/src/api/dto/documentation/block-definition.ts +0 -28
  52. package/src/api/dto/documentation/block.ts +0 -6
  53. package/src/api/dto/documentation/documentation-page-snapshot.ts +0 -18
  54. package/src/api/dto/documentation/index.ts +0 -8
  55. package/src/api/dto/documentation/link-preview.ts +0 -23
  56. package/src/api/dto/documentation/publish.ts +0 -23
  57. package/src/api/dto/documentation/room.ts +0 -12
  58. package/src/api/dto/elements/components/figma-component-group.ts +0 -19
  59. package/src/api/dto/elements/components/figma-component.ts +0 -56
  60. package/src/api/dto/elements/components/index.ts +0 -2
  61. package/src/api/dto/elements/documentation/draft-state.ts +0 -37
  62. package/src/api/dto/elements/documentation/group-action.ts +0 -108
  63. package/src/api/dto/elements/documentation/group-v1.ts +0 -35
  64. package/src/api/dto/elements/documentation/group-v2.ts +0 -117
  65. package/src/api/dto/elements/documentation/hierarchy.ts +0 -22
  66. package/src/api/dto/elements/documentation/index.ts +0 -13
  67. package/src/api/dto/elements/documentation/item-configuration-v1.ts +0 -24
  68. package/src/api/dto/elements/documentation/item-configuration-v2.ts +0 -14
  69. package/src/api/dto/elements/documentation/metadata.ts +0 -8
  70. package/src/api/dto/elements/documentation/page-actions-v2.ts +0 -121
  71. package/src/api/dto/elements/documentation/page-content.ts +0 -15
  72. package/src/api/dto/elements/documentation/page-v1.ts +0 -21
  73. package/src/api/dto/elements/documentation/page-v2.ts +0 -123
  74. package/src/api/dto/elements/documentation/structure.ts +0 -37
  75. package/src/api/dto/elements/elements-action-v2.ts +0 -117
  76. package/src/api/dto/elements/figma-nodes/figma-node-v1.ts +0 -32
  77. package/src/api/dto/elements/figma-nodes/figma-node-v2.ts +0 -32
  78. package/src/api/dto/elements/figma-nodes/figma-node.ts +0 -103
  79. package/src/api/dto/elements/figma-nodes/index.ts +0 -4
  80. package/src/api/dto/elements/figma-nodes/node-actions-v2.ts +0 -44
  81. package/src/api/dto/elements/frame-node-structures/frame-node-structure.ts +0 -17
  82. package/src/api/dto/elements/frame-node-structures/index.ts +0 -1
  83. package/src/api/dto/elements/get-elements-v2.ts +0 -27
  84. package/src/api/dto/elements/index.ts +0 -7
  85. package/src/api/dto/elements/properties/index.ts +0 -2
  86. package/src/api/dto/elements/properties/property-definitions.ts +0 -75
  87. package/src/api/dto/elements/properties/property-values.ts +0 -38
  88. package/src/api/dto/export/exporter-property.ts +0 -105
  89. package/src/api/dto/export/exporter.ts +0 -87
  90. package/src/api/dto/export/filter.ts +0 -6
  91. package/src/api/dto/export/index.ts +0 -5
  92. package/src/api/dto/export/job.ts +0 -96
  93. package/src/api/dto/export/pipeline.ts +0 -43
  94. package/src/api/dto/figma-components/assets/download.ts +0 -30
  95. package/src/api/dto/figma-components/assets/index.ts +0 -1
  96. package/src/api/dto/figma-components/index.ts +0 -1
  97. package/src/api/dto/index.ts +0 -13
  98. package/src/api/dto/liveblocks/auth-response.ts +0 -7
  99. package/src/api/dto/liveblocks/index.ts +0 -1
  100. package/src/api/dto/themes/index.ts +0 -2
  101. package/src/api/dto/themes/override.ts +0 -27
  102. package/src/api/dto/themes/theme.ts +0 -45
  103. package/src/api/dto/users/authenticated-user.ts +0 -46
  104. package/src/api/dto/users/index.ts +0 -3
  105. package/src/api/dto/users/update.ts +0 -8
  106. package/src/api/dto/users/user.ts +0 -31
  107. package/src/api/dto/workspaces/git.ts +0 -32
  108. package/src/api/dto/workspaces/index.ts +0 -6
  109. package/src/api/dto/workspaces/integrations.ts +0 -34
  110. package/src/api/dto/workspaces/invitations.ts +0 -30
  111. package/src/api/dto/workspaces/membership.ts +0 -41
  112. package/src/api/dto/workspaces/npm-registry.ts +0 -35
  113. package/src/api/dto/workspaces/workspace.ts +0 -34
  114. package/src/api/endpoints/codegen/codegen.ts +0 -16
  115. package/src/api/endpoints/codegen/exporters.ts +0 -25
  116. package/src/api/endpoints/codegen/index.ts +0 -4
  117. package/src/api/endpoints/codegen/jobs.ts +0 -15
  118. package/src/api/endpoints/codegen/pipelines.ts +0 -44
  119. package/src/api/endpoints/design-system/bff.ts +0 -13
  120. package/src/api/endpoints/design-system/contact.ts +0 -12
  121. package/src/api/endpoints/design-system/design-systems.ts +0 -55
  122. package/src/api/endpoints/design-system/index.ts +0 -6
  123. package/src/api/endpoints/design-system/members.ts +0 -24
  124. package/src/api/endpoints/design-system/sources.ts +0 -35
  125. package/src/api/endpoints/design-system/versions/brands.ts +0 -45
  126. package/src/api/endpoints/design-system/versions/documentation.ts +0 -27
  127. package/src/api/endpoints/design-system/versions/ds-components.ts +0 -28
  128. package/src/api/endpoints/design-system/versions/elements-action.ts +0 -63
  129. package/src/api/endpoints/design-system/versions/elements.ts +0 -27
  130. package/src/api/endpoints/design-system/versions/figma-component-groups.ts +0 -13
  131. package/src/api/endpoints/design-system/versions/figma-components.ts +0 -13
  132. package/src/api/endpoints/design-system/versions/figma-frame-structures.ts +0 -13
  133. package/src/api/endpoints/design-system/versions/import-jobs.ts +0 -13
  134. package/src/api/endpoints/design-system/versions/index.ts +0 -18
  135. package/src/api/endpoints/design-system/versions/overrides.ts +0 -17
  136. package/src/api/endpoints/design-system/versions/property-definitions.ts +0 -43
  137. package/src/api/endpoints/design-system/versions/property-values.ts +0 -25
  138. package/src/api/endpoints/design-system/versions/stats.ts +0 -12
  139. package/src/api/endpoints/design-system/versions/themes.ts +0 -35
  140. package/src/api/endpoints/design-system/versions/token-collections.ts +0 -13
  141. package/src/api/endpoints/design-system/versions/token-groups.ts +0 -28
  142. package/src/api/endpoints/design-system/versions/tokens.ts +0 -27
  143. package/src/api/endpoints/design-system/versions/versions.ts +0 -87
  144. package/src/api/endpoints/index.ts +0 -5
  145. package/src/api/endpoints/liveblocks.ts +0 -14
  146. package/src/api/endpoints/users.ts +0 -26
  147. package/src/api/endpoints/workspaces/index.ts +0 -3
  148. package/src/api/endpoints/workspaces/workspace-invites.ts +0 -34
  149. package/src/api/endpoints/workspaces/workspace-members.ts +0 -31
  150. package/src/api/endpoints/workspaces/workspaces.ts +0 -47
  151. package/src/api/index.ts +0 -6
  152. package/src/api/payloads/design-systems/index.ts +0 -2
  153. package/src/api/payloads/design-systems/update-design-system.ts +0 -29
  154. package/src/api/payloads/design-systems/version.ts +0 -29
  155. package/src/api/payloads/documentation/block-definitions.ts +0 -12
  156. package/src/api/payloads/documentation/design-data-doc-diff.ts +0 -7
  157. package/src/api/payloads/documentation/index.ts +0 -2
  158. package/src/api/payloads/export/index.ts +0 -1
  159. package/src/api/payloads/export/pipeline.ts +0 -74
  160. package/src/api/payloads/index.ts +0 -6
  161. package/src/api/payloads/liveblocks/auth.ts +0 -7
  162. package/src/api/payloads/liveblocks/index.ts +0 -1
  163. package/src/api/payloads/users/index.ts +0 -2
  164. package/src/api/payloads/users/notifications/index.ts +0 -1
  165. package/src/api/payloads/users/notifications/notification-settings.ts +0 -17
  166. package/src/api/payloads/users/profile/index.ts +0 -1
  167. package/src/api/payloads/users/profile/update.ts +0 -4
  168. package/src/api/payloads/workspaces/index.ts +0 -3
  169. package/src/api/payloads/workspaces/transfer-ownership.ts +0 -7
  170. package/src/api/payloads/workspaces/workspace-configuration.ts +0 -50
  171. package/src/api/payloads/workspaces/workspace-integrations.ts +0 -26
  172. package/src/api/transport/index.ts +0 -2
  173. package/src/api/transport/request-executor-error.ts +0 -66
  174. package/src/api/transport/request-executor.ts +0 -87
  175. package/src/events/design-system.ts +0 -21
  176. package/src/events/event.ts +0 -6
  177. package/src/events/index.ts +0 -2
  178. package/src/index.ts +0 -4
  179. package/src/utils/figma.ts +0 -72
  180. package/src/utils/hash.ts +0 -62
  181. package/src/utils/index.ts +0 -3
  182. package/src/utils/query.ts +0 -18
  183. package/src/yjs/design-system-content/documentation-hierarchy.ts +0 -35
  184. package/src/yjs/design-system-content/index.ts +0 -2
  185. package/src/yjs/design-system-content/item-configuration.ts +0 -93
  186. package/src/yjs/docs-editor/blocks-to-prosemirror.ts +0 -764
  187. package/src/yjs/docs-editor/index.ts +0 -7
  188. package/src/yjs/docs-editor/list-tree-builder.ts +0 -127
  189. package/src/yjs/docs-editor/mock.ts +0 -2142
  190. package/src/yjs/docs-editor/model/block.ts +0 -8
  191. package/src/yjs/docs-editor/model/index.ts +0 -2
  192. package/src/yjs/docs-editor/model/page.ts +0 -8
  193. package/src/yjs/docs-editor/prosemirror/index.ts +0 -3
  194. package/src/yjs/docs-editor/prosemirror/inner-editor-schema.ts +0 -145
  195. package/src/yjs/docs-editor/prosemirror/main-editor-schema.ts +0 -577
  196. package/src/yjs/docs-editor/prosemirror/types.ts +0 -19
  197. package/src/yjs/docs-editor/prosemirror-to-blocks.ts +0 -975
  198. package/src/yjs/docs-editor/utils.ts +0 -115
  199. package/src/yjs/index.ts +0 -3
  200. package/src/yjs/version-room/backend.ts +0 -83
  201. package/src/yjs/version-room/base.ts +0 -252
  202. package/src/yjs/version-room/frontend.ts +0 -463
  203. package/src/yjs/version-room/index.ts +0 -4
  204. package/src/yjs/version-room/utils.ts +0 -109
@@ -1,108 +0,0 @@
1
- import { z } from "zod";
2
- import {
3
- DTOCreateDocumentationGroupInput,
4
- DTOCreateDocumentationTabInput,
5
- DTODeleteDocumentationGroupInput,
6
- DTODeleteDocumentationTabGroupInput,
7
- DTODuplicateDocumentationGroupInput,
8
- DTOMoveDocumentationGroupInput,
9
- DTOUpdateDocumentationGroupInput,
10
- } from "./group-v2";
11
-
12
- //
13
- // Read
14
- //
15
-
16
- const SuccessPayload = z.object({
17
- success: z.literal(true),
18
- });
19
-
20
- export const DTODocumentationGroupCreateActionOutputV2 = z.object({
21
- type: z.literal("DocumentationGroupCreate"),
22
- output: SuccessPayload,
23
- });
24
-
25
- export const DTODocumentationTabCreateActionOutputV2 = z.object({
26
- type: z.literal("DocumentationTabCreate"),
27
- output: SuccessPayload,
28
- });
29
-
30
- export const DTODocumentationGroupUpdateActionOutputV2 = z.object({
31
- type: z.literal("DocumentationGroupUpdate"),
32
- output: SuccessPayload,
33
- });
34
-
35
- export const DTODocumentationGroupMoveActionOutputV2 = z.object({
36
- type: z.literal("DocumentationGroupMove"),
37
- output: SuccessPayload,
38
- });
39
-
40
- export const DTODocumentationGroupDuplicateActionOutputV2 = z.object({
41
- type: z.literal("DocumentationGroupDuplicate"),
42
- output: SuccessPayload,
43
- });
44
-
45
- export const DTODocumentationGroupDeleteActionOutputV2 = z.object({
46
- type: z.literal("DocumentationGroupDelete"),
47
- output: SuccessPayload,
48
- });
49
-
50
- export const DTODocumentationTabGroupDeleteActionOutputV2 = z.object({
51
- type: z.literal("DocumentationTabGroupDelete"),
52
- output: SuccessPayload,
53
- });
54
-
55
- export type DTODocumentationGroupCreateActionOutputV2 = z.infer<typeof DTODocumentationGroupCreateActionOutputV2>;
56
- export type DTODocumentationTabCreateActionOutputV2 = z.infer<typeof DTODocumentationTabCreateActionOutputV2>;
57
- export type DTODocumentationGroupUpdateActionOutputV2 = z.infer<typeof DTODocumentationGroupUpdateActionOutputV2>;
58
- export type DTODocumentationGroupMoveActionOutputV2 = z.infer<typeof DTODocumentationGroupMoveActionOutputV2>;
59
- export type DTODocumentationGroupDuplicateActionOutputV2 = z.infer<typeof DTODocumentationGroupDuplicateActionOutputV2>;
60
- export type DTODocumentationGroupDeleteActionOutputV2 = z.infer<typeof DTODocumentationGroupDeleteActionOutputV2>;
61
- export type DTODocumentationTabGroupDeleteActionOutputV2 = z.infer<typeof DTODocumentationTabGroupDeleteActionOutputV2>;
62
-
63
- //
64
- // Write
65
- //
66
-
67
- export const DTODocumentationGroupCreateActionInputV2 = z.object({
68
- type: z.literal("DocumentationGroupCreate"),
69
- input: DTOCreateDocumentationGroupInput,
70
- });
71
-
72
- export const DTODocumentationTabCreateActionInputV2 = z.object({
73
- type: z.literal("DocumentationTabCreate"),
74
- input: DTOCreateDocumentationTabInput,
75
- });
76
-
77
- export const DTODocumentationGroupUpdateActionInputV2 = z.object({
78
- type: z.literal("DocumentationGroupUpdate"),
79
- input: DTOUpdateDocumentationGroupInput,
80
- });
81
-
82
- export const DTODocumentationGroupMoveActionInputV2 = z.object({
83
- type: z.literal("DocumentationGroupMove"),
84
- input: DTOMoveDocumentationGroupInput,
85
- });
86
-
87
- export const DTODocumentationGroupDuplicateActionInputV2 = z.object({
88
- type: z.literal("DocumentationGroupDuplicate"),
89
- input: DTODuplicateDocumentationGroupInput,
90
- });
91
-
92
- export const DTODocumentationGroupDeleteActionInputV2 = z.object({
93
- type: z.literal("DocumentationGroupDelete"),
94
- input: DTODeleteDocumentationGroupInput,
95
- });
96
-
97
- export const DTODocumentationTabGroupDeleteActionInputV2 = z.object({
98
- type: z.literal("DocumentationTabGroupDelete"),
99
- input: DTODeleteDocumentationTabGroupInput,
100
- });
101
-
102
- export type DTODocumentationGroupCreateActionInputV2 = z.infer<typeof DTODocumentationGroupCreateActionInputV2>;
103
- export type DTODocumentationTabGroupCreateActionInputV2 = z.infer<typeof DTODocumentationTabCreateActionInputV2>;
104
- export type DTODocumentationGroupUpdateActionInputV2 = z.infer<typeof DTODocumentationGroupUpdateActionInputV2>;
105
- export type DTODocumentationGroupMoveActionInputV2 = z.infer<typeof DTODocumentationGroupMoveActionInputV2>;
106
- export type DTODocumentationGroupDuplicateActionInputV2 = z.infer<typeof DTODocumentationGroupDuplicateActionInputV2>;
107
- export type DTODocumentationGroupDeleteActionInputV2 = z.infer<typeof DTODocumentationGroupDeleteActionInputV2>;
108
- export type DTODocumentationTabGroupDeleteActionInputV2 = z.infer<typeof DTODocumentationTabGroupDeleteActionInputV2>;
@@ -1,35 +0,0 @@
1
- import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
2
- import { z } from "zod";
3
- import { DTODocumentationItemConfigurationV1 } from "./item-configuration-v1";
4
-
5
- //
6
- // Read
7
- //
8
-
9
- /**
10
- * Structure DTO is element properties minus element data (in other words data required
11
- * to display the element in the left panel)
12
- */
13
- export const DTODocumentationGroupStructureV1 = ElementGroup.omit({
14
- sortOrder: true,
15
- parentPersistentId: true,
16
- brandPersistentId: true,
17
- meta: true,
18
- childType: true,
19
- data: true,
20
- shortPersistentId: true,
21
- }).extend({
22
- title: z.string(),
23
- isRoot: z.boolean(),
24
- childrenIds: z.array(z.string()),
25
- groupBehavior: DocumentationGroupBehavior,
26
- shortPersistentId: z.string(),
27
- type: z.literal("Group"),
28
- });
29
-
30
- export const DTODocumentationGroupV1 = DTODocumentationGroupStructureV1.extend({
31
- configuration: DTODocumentationItemConfigurationV1,
32
- });
33
-
34
- export type DTODocumentationGroupStructureV1 = z.infer<typeof DTODocumentationGroupStructureV1>;
35
- export type DTODocumentationGroupV1 = z.infer<typeof DTODocumentationGroupV1>;
@@ -1,117 +0,0 @@
1
- import { DocumentationGroupBehavior, ElementGroup } from "@supernova-studio/model";
2
- import { z } from "zod";
3
- import { DTODocumentationDraftState } from "./draft-state";
4
- import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
5
- import { DTODocumentationPublishMetadata } from "./metadata";
6
- import { DTODocumentationGroupApprovalState } from "../../documentation";
7
-
8
- //
9
- // Read
10
- //
11
-
12
- export const DTODocumentationGroupV2 = ElementGroup.omit({
13
- sortOrder: true,
14
- parentPersistentId: true,
15
- brandPersistentId: true,
16
- meta: true,
17
- childType: true,
18
- data: true,
19
- shortPersistentId: true,
20
- }).extend({
21
- title: z.string(),
22
- isRoot: z.boolean(),
23
- childrenIds: z.array(z.string()),
24
- groupBehavior: DocumentationGroupBehavior,
25
- shortPersistentId: z.string(),
26
- configuration: DTODocumentationItemConfigurationV2,
27
- type: z.literal("Group"),
28
-
29
- /** Defined when a group has changed since last publish and can be included into a partial publish */
30
- draftState: DTODocumentationDraftState.optional(),
31
-
32
- /** Defined if a group was published at least once and contains metadata about last publish */
33
- publishMetadata: DTODocumentationPublishMetadata.optional(),
34
-
35
- //** An approval state for frontend to utilize. */
36
- approvalState: DTODocumentationGroupApprovalState.optional(),
37
- });
38
-
39
- export type DTODocumentationGroupV2 = z.infer<typeof DTODocumentationGroupV2>;
40
-
41
- //
42
- // Write
43
- //
44
-
45
- export const DTOCreateDocumentationGroupInput = z.object({
46
- // Identifier
47
- persistentId: z.string(),
48
-
49
- // Group properties
50
- title: z.string(),
51
- configuration: DTODocumentationItemConfigurationV2.partial().optional(),
52
-
53
- // Group placement properties
54
- afterPersistentId: z.string().nullish(),
55
- parentPersistentId: z.string(),
56
- });
57
-
58
- export const DTOUpdateDocumentationGroupInput = z.object({
59
- // Identifier of the group to update
60
- id: z.string(),
61
-
62
- // Group properties
63
- title: z.string().optional(),
64
- configuration: DTODocumentationItemConfigurationV2.partial().optional(),
65
- });
66
-
67
- export const DTOMoveDocumentationGroupInput = z.object({
68
- // Identifier of the group to update
69
- id: z.string(),
70
-
71
- // Group placement properties
72
- parentPersistentId: z.string(),
73
- afterPersistentId: z.string().nullish(),
74
- });
75
-
76
- export const DTODuplicateDocumentationGroupInput = z.object({
77
- // Identifier of the group to duplicate from
78
- id: z.string(),
79
-
80
- // New group persistent id
81
- persistentId: z.string(),
82
-
83
- // Group placement properties
84
- afterPersistentId: z.string().nullish(),
85
- parentPersistentId: z.string(),
86
- });
87
-
88
- export const DTOCreateDocumentationTabInput = z.object({
89
- // New group persistent id
90
- persistentId: z.string(),
91
-
92
- // If this is page, we will attempt to convert it to tab
93
- // If this is tab group, we will add a new tab to it
94
- fromItemPersistentId: z.string(),
95
- tabName: z.string(),
96
- });
97
-
98
- export const DTODeleteDocumentationTabGroupInput = z.object({
99
- // Deleted group id
100
- id: z.string(),
101
- });
102
-
103
- export const DTODeleteDocumentationGroupInput = z.object({
104
- // Identifier
105
- id: z.string(),
106
-
107
- // Deletion options
108
- deleteSubtree: z.boolean().default(false),
109
- });
110
-
111
- export type DTOCreateDocumentationGroupInput = z.infer<typeof DTOCreateDocumentationGroupInput>;
112
- export type DTOUpdateDocumentationGroupInput = z.infer<typeof DTOUpdateDocumentationGroupInput>;
113
- export type DTOMoveDocumentationGroupInput = z.infer<typeof DTOMoveDocumentationGroupInput>;
114
- export type DTODuplicateDocumentationGroupInput = z.infer<typeof DTODuplicateDocumentationGroupInput>;
115
- export type DTOCreateDocumentationTabInput = z.infer<typeof DTOCreateDocumentationTabInput>;
116
- export type DTODeleteDocumentationTabGroupInput = z.infer<typeof DTODeleteDocumentationTabGroupInput>;
117
- export type DTODeleteDocumentationGroupInput = z.infer<typeof DTODeleteDocumentationGroupInput>;
@@ -1,22 +0,0 @@
1
- import { z } from "zod";
2
- import { DTODocumentationDraftState } from "./draft-state";
3
- import { DTODocumentationGroupV2 } from "./group-v2";
4
- import { DTODocumentationPageV2 } from "./page-v2";
5
-
6
- export const DTODocumentationHierarchyV2 = z.object({
7
- pages: z.array(
8
- DTODocumentationPageV2.extend({
9
- /** Defined when a page has changed since last publish and can be included into a partial publish */
10
- draftState: DTODocumentationDraftState.optional(),
11
- })
12
- ),
13
-
14
- groups: z.array(
15
- DTODocumentationGroupV2.extend({
16
- /** Defined when a page has changed since last publish and can be included into a partial publish */
17
- draftState: DTODocumentationDraftState.optional(),
18
- })
19
- ),
20
- });
21
-
22
- export type DTODocumentationHierarchyV2 = z.infer<typeof DTODocumentationHierarchyV2>;
@@ -1,13 +0,0 @@
1
- export * from "./draft-state";
2
- export * from "./group-action";
3
- export * from "./group-v1";
4
- export * from "./group-v2";
5
- export * from "./hierarchy";
6
- export * from "./item-configuration-v1";
7
- export * from "./item-configuration-v2";
8
- export * from "./metadata";
9
- export * from "./page-actions-v2";
10
- export * from "./page-content";
11
- export * from "./page-v1";
12
- export * from "./page-v2";
13
- export * from "./structure";
@@ -1,24 +0,0 @@
1
- import { DocumentationItemHeaderV1 } from "@supernova-studio/model";
2
- import { z } from "zod";
3
-
4
- const DocumentationColorV1 = z.object({
5
- aliasTo: z.string().optional(),
6
- value: z.string().optional(),
7
- });
8
-
9
- const DTODocumentationItemHeaderV1 = DocumentationItemHeaderV1.omit({
10
- foregroundColor: true,
11
- backgroundColor: true,
12
- }).extend({
13
- foregroundColor: DocumentationColorV1.optional(),
14
- backgroundColor: DocumentationColorV1.optional(),
15
- });
16
-
17
- export const DTODocumentationItemConfigurationV1 = z.object({
18
- showSidebar: z.boolean(),
19
- isPrivate: z.boolean(),
20
- isHidden: z.boolean(),
21
- header: DTODocumentationItemHeaderV1,
22
- });
23
-
24
- export type DTODocumentationItemConfigurationV1 = z.infer<typeof DTODocumentationItemConfigurationV1>;
@@ -1,14 +0,0 @@
1
- import { DocumentationItemHeaderV2 } from "@supernova-studio/model";
2
- import { z } from "zod";
3
-
4
- export const DTODocumentationItemHeaderV2 = DocumentationItemHeaderV2;
5
-
6
- export const DTODocumentationItemConfigurationV2 = z.object({
7
- showSidebar: z.boolean(),
8
- isPrivate: z.boolean(),
9
- isHidden: z.boolean(),
10
- header: DTODocumentationItemHeaderV2,
11
- });
12
-
13
- export type DTODocumentationItemHeaderV2 = z.infer<typeof DTODocumentationItemHeaderV2>;
14
- export type DTODocumentationItemConfigurationV2 = z.infer<typeof DTODocumentationItemConfigurationV2>;
@@ -1,8 +0,0 @@
1
- import { z } from "zod";
2
-
3
- export const DTODocumentationPublishMetadata = z.object({
4
- lastPublishedByUserId: z.string(),
5
- lastPublishedAt: z.coerce.date(),
6
- });
7
-
8
- export type DTODocumentationPublishMetadata = z.infer<typeof DTODocumentationPublishMetadata>;
@@ -1,121 +0,0 @@
1
- import { z } from "zod";
2
- import {
3
- DTOCreateDocumentationPageInputV2,
4
- DTODeleteDocumentationPageInputV2,
5
- DTODocumentationPageApprovalStateChangeInput,
6
- DTODuplicateDocumentationPageInputV2,
7
- DTOMoveDocumentationPageInputV2,
8
- DTORestoreDocumentationGroupInput,
9
- DTORestoreDocumentationPageInput,
10
- DTOUpdateDocumentationPageInputV2,
11
- } from "./page-v2";
12
-
13
- //
14
- // Read
15
- //
16
-
17
- const SuccessPayload = z.object({
18
- success: z.literal(true),
19
- });
20
-
21
- export const DTODocumentationPageCreateActionOutputV2 = z.object({
22
- type: z.literal("DocumentationPageCreate"),
23
- output: SuccessPayload,
24
- });
25
-
26
- export const DTODocumentationPageUpdateActionOutputV2 = z.object({
27
- type: z.literal("DocumentationPageUpdate"),
28
- output: SuccessPayload,
29
- });
30
-
31
- export const DTODocumentationPageMoveActionOutputV2 = z.object({
32
- type: z.literal("DocumentationPageMove"),
33
- output: SuccessPayload,
34
- });
35
-
36
- export const DTODocumentationPageDuplicateActionOutputV2 = z.object({
37
- type: z.literal("DocumentationPageDuplicate"),
38
- output: SuccessPayload,
39
- });
40
-
41
- export const DTODocumentationPageDeleteActionOutputV2 = z.object({
42
- type: z.literal("DocumentationPageDelete"),
43
- output: SuccessPayload,
44
- });
45
-
46
- export const DTODocumentationPageRestoreActionOutput = z.object({
47
- type: z.literal("DocumentationPageRestore"),
48
- output: SuccessPayload,
49
- });
50
-
51
- export const DTODocumentationGroupRestoreActionOutput = z.object({
52
- type: z.literal("DocumentationGroupRestore"),
53
- output: SuccessPayload,
54
- });
55
-
56
- export const DTODocumentationPageApprovalStateChangeActionOutput = z.object({
57
- type: z.literal("DocumentationPageApprovalStateChange"),
58
- output: SuccessPayload,
59
- });
60
-
61
- export type DTODocumentationPageCreateActionOutputV2 = z.infer<typeof DTODocumentationPageCreateActionOutputV2>;
62
- export type DTODocumentationPageUpdateActionOutputV2 = z.infer<typeof DTODocumentationPageUpdateActionOutputV2>;
63
- export type DTODocumentationPageMoveActionOutputV2 = z.infer<typeof DTODocumentationPageMoveActionOutputV2>;
64
- export type DTODocumentationPageDuplicateActionOutputV2 = z.infer<typeof DTODocumentationPageDuplicateActionOutputV2>;
65
- export type DTODocumentationPageDeleteActionOutputV2 = z.infer<typeof DTODocumentationPageDeleteActionOutputV2>;
66
- export type DTODocumentationPageRestoreActionOutput = z.infer<typeof DTODocumentationPageRestoreActionOutput>;
67
- export type DTODocumentationGroupRestoreActionOutput = z.infer<typeof DTODocumentationGroupRestoreActionOutput>;
68
- export type DTODocumentationPageApprovalStateChangeActionOutput = z.infer<
69
- typeof DTODocumentationPageApprovalStateChangeActionOutput
70
- >;
71
-
72
- // Write
73
- //
74
-
75
- export const DTODocumentationPageCreateActionInputV2 = z.object({
76
- type: z.literal("DocumentationPageCreate"),
77
- input: DTOCreateDocumentationPageInputV2,
78
- });
79
-
80
- export const DTODocumentationPageUpdateActionInputV2 = z.object({
81
- type: z.literal("DocumentationPageUpdate"),
82
- input: DTOUpdateDocumentationPageInputV2,
83
- });
84
-
85
- export const DTODocumentationPageMoveActionInputV2 = z.object({
86
- type: z.literal("DocumentationPageMove"),
87
- input: DTOMoveDocumentationPageInputV2,
88
- });
89
-
90
- export const DTODocumentationPageDuplicateActionInputV2 = z.object({
91
- type: z.literal("DocumentationPageDuplicate"),
92
- input: DTODuplicateDocumentationPageInputV2,
93
- });
94
-
95
- export const DTODocumentationPageDeleteActionInputV2 = z.object({
96
- type: z.literal("DocumentationPageDelete"),
97
- input: DTODeleteDocumentationPageInputV2,
98
- });
99
-
100
- export const DTODocumentationPageRestoreActionInput = z.object({
101
- type: z.literal("DocumentationPageRestore"),
102
- input: DTORestoreDocumentationPageInput,
103
- });
104
-
105
- export const DTODocumentationGroupRestoreActionInput = z.object({
106
- type: z.literal("DocumentationGroupRestore"),
107
- input: DTORestoreDocumentationGroupInput,
108
- });
109
-
110
- export const DTODocumentationPageApprovalStateChangeActionInput = z.object({
111
- type: z.literal("DocumentationPageApprovalStateChange"),
112
- input: DTODocumentationPageApprovalStateChangeInput,
113
- });
114
-
115
- export type DTODocumentationPageCreateActionInputV2 = z.infer<typeof DTODocumentationPageCreateActionInputV2>;
116
- export type DTODocumentationPageUpdateActionInputV2 = z.infer<typeof DTODocumentationPageUpdateActionInputV2>;
117
- export type DTODocumentationPageMoveActionInputV2 = z.infer<typeof DTODocumentationPageMoveActionInputV2>;
118
- export type DTODocumentationPageDuplicateActionInputV2 = z.infer<typeof DTODocumentationPageDuplicateActionInputV2>;
119
- export type DTODocumentationPageDeleteActionInputV2 = z.infer<typeof DTODocumentationPageDeleteActionInputV2>;
120
- export type DTODocumentationPageRestoreActionInput = z.infer<typeof DTODocumentationPageRestoreActionInput>;
121
- export type DTODocumentationGroupRestoreActionInput = z.infer<typeof DTODocumentationGroupRestoreActionInput>;
@@ -1,15 +0,0 @@
1
- import { DocumentationPageContent } from "@supernova-studio/model";
2
- import { z } from "zod";
3
-
4
- //
5
- // Read
6
- //
7
-
8
- export const DTODocumentationPageContent = DocumentationPageContent;
9
-
10
- export const DTODocumentationPageContentGetResponse = z.object({
11
- pageContent: DTODocumentationPageContent,
12
- });
13
-
14
- export type DTODocumentationPageContent = z.infer<typeof DTODocumentationPageContent>;
15
- export type DTODocumentationPageContentGetResponse = z.infer<typeof DTODocumentationPageContentGetResponse>;
@@ -1,21 +0,0 @@
1
- import { DocumentationPageV1, PageBlockV1 } from "@supernova-studio/model";
2
- import { z } from "zod";
3
- import { DTODocumentationItemConfigurationV1 } from "./item-configuration-v1";
4
-
5
- //
6
- // Read
7
- //
8
-
9
- export const DocumentationPageV1DTO = DocumentationPageV1.omit({
10
- data: true,
11
- meta: true,
12
- parentPersistentId: true,
13
- sortOrder: true,
14
- }).extend({
15
- configuration: DTODocumentationItemConfigurationV1,
16
- blocks: z.array(PageBlockV1),
17
- title: z.string(),
18
- path: z.string(),
19
- });
20
-
21
- export type DocumentationPageV1DTO = z.infer<typeof DocumentationPageV1DTO>;
@@ -1,123 +0,0 @@
1
- import { DocumentationPageApprovalState } from "@supernova-studio/model";
2
- import { z } from "zod";
3
- import { DTODocumentationPageApprovalState } from "../../documentation";
4
- import { DTODocumentationDraftState } from "./draft-state";
5
- import { DTODocumentationItemConfigurationV2 } from "./item-configuration-v2";
6
- import { DTODocumentationPublishMetadata } from "./metadata";
7
-
8
- //
9
- // Read
10
- //
11
-
12
- export const DTODocumentationPageV2 = z.object({
13
- id: z.string(),
14
- persistentId: z.string(),
15
-
16
- designSystemVersionId: z.string(),
17
-
18
- title: z.string(),
19
- configuration: DTODocumentationItemConfigurationV2,
20
-
21
- shortPersistentId: z.string(),
22
-
23
- slug: z.string().optional(),
24
- userSlug: z.string().optional(),
25
-
26
- createdAt: z.coerce.date(),
27
- updatedAt: z.coerce.date(),
28
-
29
- path: z.string(),
30
-
31
- /** Defined when a page has changed since last publish and can be included into a partial publish */
32
- draftState: DTODocumentationDraftState.optional(),
33
-
34
- /** Defined if a page was published at least once and contains metadata about last publish */
35
- publishMetadata: DTODocumentationPublishMetadata.optional(),
36
-
37
- /** Defines the approval state of the documentation page */
38
- approvalState: DTODocumentationPageApprovalState.optional(),
39
-
40
- /** Id of the page document room */
41
- liveblocksRoomId: z.string().optional(),
42
-
43
- // Backward compatibility
44
- type: z.literal("Page"),
45
- });
46
-
47
- export type DTODocumentationPageV2 = z.infer<typeof DTODocumentationPageV2>;
48
-
49
- //
50
- // Write
51
- //
52
-
53
- export const DTOCreateDocumentationPageInputV2 = z.object({
54
- // Identifier
55
- persistentId: z.string(),
56
-
57
- // Page properties
58
- title: z.string(),
59
- configuration: DTODocumentationItemConfigurationV2.partial().optional(),
60
-
61
- // Page placement properties
62
- parentPersistentId: z.string(),
63
- afterPersistentId: z.string().nullish(),
64
- });
65
-
66
- export const DTOUpdateDocumentationPageInputV2 = z.object({
67
- // Identifier of the group to update
68
- id: z.string(),
69
-
70
- // Page properties
71
- title: z.string().optional(),
72
- configuration: DTODocumentationItemConfigurationV2.partial().optional(),
73
- });
74
-
75
- export const DTOMoveDocumentationPageInputV2 = z.object({
76
- // Identifier of the group to update
77
- id: z.string(),
78
-
79
- // Page placement properties
80
- parentPersistentId: z.string(),
81
- afterPersistentId: z.string().nullish(),
82
- });
83
-
84
- export const DTODuplicateDocumentationPageInputV2 = z.object({
85
- // Identifier of the page to duplicate from
86
- id: z.string(),
87
-
88
- // New page persistent id
89
- persistentId: z.string(),
90
-
91
- // Page placement properties
92
- parentPersistentId: z.string(),
93
- afterPersistentId: z.string().nullish(),
94
- });
95
-
96
- export const DTODeleteDocumentationPageInputV2 = z.object({
97
- // Identifier
98
- id: z.string(),
99
- });
100
-
101
- export const DTORestoreDocumentationPageInput = z.object({
102
- persistentId: z.string(),
103
- snapshotId: z.string().optional(),
104
- });
105
-
106
- export const DTORestoreDocumentationGroupInput = z.object({
107
- persistentId: z.string(),
108
- snapshotId: z.string().optional(),
109
- });
110
-
111
- export const DTODocumentationPageApprovalStateChangeInput = z.object({
112
- persistentId: z.string(),
113
- approvalState: DocumentationPageApprovalState.optional(),
114
- });
115
-
116
- export type DTOCreateDocumentationPageInputV2 = z.infer<typeof DTOCreateDocumentationPageInputV2>;
117
- export type DTOUpdateDocumentationPageInputV2 = z.infer<typeof DTOUpdateDocumentationPageInputV2>;
118
- export type DTOMoveDocumentationPageInputV2 = z.infer<typeof DTOMoveDocumentationPageInputV2>;
119
- export type DTODuplicateDocumentationPageInputV2 = z.infer<typeof DTODuplicateDocumentationPageInputV2>;
120
- export type DTODeleteDocumentationPageInputV2 = z.infer<typeof DTODeleteDocumentationPageInputV2>;
121
- export type DTORestoreDocumentationPageInput = z.infer<typeof DTORestoreDocumentationPageInput>;
122
- export type DTORestoreDocumentationGroupInput = z.infer<typeof DTORestoreDocumentationGroupInput>;
123
- export type DTODocumentationPageApprovalStateChangeInput = z.infer<typeof DTODocumentationPageApprovalStateChangeInput>;
@@ -1,37 +0,0 @@
1
- import { z } from "zod";
2
-
3
- const DTODocumentationStructureItemType = z.enum(["Group", "Page"]);
4
-
5
- const DTODocumentationStructureItemBase = z.object({
6
- type: DTODocumentationStructureItemType,
7
- id: z.string(),
8
- designSystemVersionId: z.string(),
9
- shortPersistentId: z.string(),
10
- persistentId: z.string(),
11
- title: z.string(),
12
- createdAt: z.coerce.date(),
13
- updatedAt: z.coerce.date(),
14
- });
15
-
16
- export const DTODocumentationStructureGroupItem = DTODocumentationStructureItemBase.extend({
17
- type: z.literal(DTODocumentationStructureItemType.enum.Group),
18
- groupBehavior: z.string(),
19
- childrenIds: z.string().array(),
20
- isRoot: z.boolean(),
21
- });
22
-
23
- export const DTODocumentationStructurePageItem = DTODocumentationStructureItemBase.extend({
24
- type: z.literal(DTODocumentationStructureItemType.enum.Page),
25
- path: z.string(),
26
- });
27
-
28
- export const DTODocumentationStructureItem = z.discriminatedUnion("type", [
29
- DTODocumentationStructureGroupItem,
30
- DTODocumentationStructurePageItem,
31
- ]);
32
- export const DTODocumentationStructure = z.object({
33
- items: z.array(DTODocumentationStructureItem),
34
- });
35
-
36
- export type DTODocumentationStructureItem = z.infer<typeof DTODocumentationStructureItem>;
37
- export type DTODocumentationStructure = z.infer<typeof DTODocumentationStructure>;