@supernova-studio/client 0.58.18 → 1.0.0-alpha.2

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 (196) hide show
  1. package/dist/index.d.mts +1349 -1323
  2. package/dist/index.d.ts +1349 -1323
  3. package/dist/index.js +462 -329
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +764 -631
  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 -72
  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 -25
  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 -13
  40. package/src/api/dto/design-systems/members.ts +0 -50
  41. package/src/api/dto/design-systems/role.ts +0 -11
  42. package/src/api/dto/design-systems/stats.ts +0 -19
  43. package/src/api/dto/design-systems/version.ts +0 -56
  44. package/src/api/dto/design-systems/view.ts +0 -45
  45. package/src/api/dto/design-tokens/design-token.ts +0 -78
  46. package/src/api/dto/design-tokens/index.ts +0 -1
  47. package/src/api/dto/documentation/anchor.ts +0 -15
  48. package/src/api/dto/documentation/approvals.ts +0 -15
  49. package/src/api/dto/documentation/block-definition.ts +0 -28
  50. package/src/api/dto/documentation/block.ts +0 -6
  51. package/src/api/dto/documentation/documentation-page-snapshot.ts +0 -18
  52. package/src/api/dto/documentation/index.ts +0 -8
  53. package/src/api/dto/documentation/link-preview.ts +0 -23
  54. package/src/api/dto/documentation/publish.ts +0 -23
  55. package/src/api/dto/documentation/room.ts +0 -12
  56. package/src/api/dto/elements/components/figma-component-group.ts +0 -19
  57. package/src/api/dto/elements/components/figma-component.ts +0 -56
  58. package/src/api/dto/elements/components/index.ts +0 -2
  59. package/src/api/dto/elements/documentation/draft-state.ts +0 -37
  60. package/src/api/dto/elements/documentation/group-action.ts +0 -108
  61. package/src/api/dto/elements/documentation/group-v1.ts +0 -35
  62. package/src/api/dto/elements/documentation/group-v2.ts +0 -117
  63. package/src/api/dto/elements/documentation/hierarchy.ts +0 -22
  64. package/src/api/dto/elements/documentation/index.ts +0 -13
  65. package/src/api/dto/elements/documentation/item-configuration-v1.ts +0 -24
  66. package/src/api/dto/elements/documentation/item-configuration-v2.ts +0 -14
  67. package/src/api/dto/elements/documentation/metadata.ts +0 -8
  68. package/src/api/dto/elements/documentation/page-actions-v2.ts +0 -121
  69. package/src/api/dto/elements/documentation/page-content.ts +0 -15
  70. package/src/api/dto/elements/documentation/page-v1.ts +0 -21
  71. package/src/api/dto/elements/documentation/page-v2.ts +0 -120
  72. package/src/api/dto/elements/documentation/structure.ts +0 -37
  73. package/src/api/dto/elements/elements-action-v2.ts +0 -104
  74. package/src/api/dto/elements/figma-nodes/figma-node.ts +0 -106
  75. package/src/api/dto/elements/figma-nodes/index.ts +0 -2
  76. package/src/api/dto/elements/figma-nodes/node-actions-v2.ts +0 -24
  77. package/src/api/dto/elements/frame-node-structures/frame-node-structure.ts +0 -17
  78. package/src/api/dto/elements/frame-node-structures/index.ts +0 -1
  79. package/src/api/dto/elements/get-elements-v2.ts +0 -21
  80. package/src/api/dto/elements/index.ts +0 -7
  81. package/src/api/dto/elements/properties/index.ts +0 -2
  82. package/src/api/dto/elements/properties/property-definitions.ts +0 -75
  83. package/src/api/dto/elements/properties/property-values.ts +0 -38
  84. package/src/api/dto/export/exporter-property.ts +0 -95
  85. package/src/api/dto/export/exporter.ts +0 -87
  86. package/src/api/dto/export/filter.ts +0 -6
  87. package/src/api/dto/export/index.ts +0 -5
  88. package/src/api/dto/export/job.ts +0 -87
  89. package/src/api/dto/export/pipeline.ts +0 -43
  90. package/src/api/dto/figma-components/assets/download.ts +0 -30
  91. package/src/api/dto/figma-components/assets/index.ts +0 -1
  92. package/src/api/dto/figma-components/index.ts +0 -1
  93. package/src/api/dto/index.ts +0 -13
  94. package/src/api/dto/liveblocks/auth-response.ts +0 -7
  95. package/src/api/dto/liveblocks/index.ts +0 -1
  96. package/src/api/dto/themes/index.ts +0 -2
  97. package/src/api/dto/themes/override.ts +0 -27
  98. package/src/api/dto/themes/theme.ts +0 -45
  99. package/src/api/dto/users/authenticated-user.ts +0 -43
  100. package/src/api/dto/users/index.ts +0 -3
  101. package/src/api/dto/users/update.ts +0 -8
  102. package/src/api/dto/users/user.ts +0 -31
  103. package/src/api/dto/workspaces/git.ts +0 -32
  104. package/src/api/dto/workspaces/index.ts +0 -6
  105. package/src/api/dto/workspaces/integrations.ts +0 -34
  106. package/src/api/dto/workspaces/invitations.ts +0 -30
  107. package/src/api/dto/workspaces/membership.ts +0 -41
  108. package/src/api/dto/workspaces/npm-registry.ts +0 -35
  109. package/src/api/dto/workspaces/workspace.ts +0 -34
  110. package/src/api/endpoints/codegen/codegen.ts +0 -13
  111. package/src/api/endpoints/codegen/exporters.ts +0 -13
  112. package/src/api/endpoints/codegen/index.ts +0 -3
  113. package/src/api/endpoints/codegen/pipelines.ts +0 -37
  114. package/src/api/endpoints/design-system/bff.ts +0 -13
  115. package/src/api/endpoints/design-system/contact.ts +0 -12
  116. package/src/api/endpoints/design-system/design-systems.ts +0 -55
  117. package/src/api/endpoints/design-system/index.ts +0 -6
  118. package/src/api/endpoints/design-system/members.ts +0 -24
  119. package/src/api/endpoints/design-system/sources.ts +0 -35
  120. package/src/api/endpoints/design-system/versions/brands.ts +0 -45
  121. package/src/api/endpoints/design-system/versions/documentation.ts +0 -27
  122. package/src/api/endpoints/design-system/versions/ds-components.ts +0 -28
  123. package/src/api/endpoints/design-system/versions/elements-action.ts +0 -55
  124. package/src/api/endpoints/design-system/versions/elements.ts +0 -13
  125. package/src/api/endpoints/design-system/versions/figma-component-groups.ts +0 -13
  126. package/src/api/endpoints/design-system/versions/figma-components.ts +0 -13
  127. package/src/api/endpoints/design-system/versions/figma-frame-structures.ts +0 -13
  128. package/src/api/endpoints/design-system/versions/import-jobs.ts +0 -13
  129. package/src/api/endpoints/design-system/versions/index.ts +0 -18
  130. package/src/api/endpoints/design-system/versions/overrides.ts +0 -17
  131. package/src/api/endpoints/design-system/versions/property-definitions.ts +0 -43
  132. package/src/api/endpoints/design-system/versions/property-values.ts +0 -25
  133. package/src/api/endpoints/design-system/versions/stats.ts +0 -12
  134. package/src/api/endpoints/design-system/versions/themes.ts +0 -35
  135. package/src/api/endpoints/design-system/versions/token-collections.ts +0 -13
  136. package/src/api/endpoints/design-system/versions/token-groups.ts +0 -28
  137. package/src/api/endpoints/design-system/versions/tokens.ts +0 -27
  138. package/src/api/endpoints/design-system/versions/versions.ts +0 -79
  139. package/src/api/endpoints/index.ts +0 -5
  140. package/src/api/endpoints/liveblocks.ts +0 -14
  141. package/src/api/endpoints/users.ts +0 -26
  142. package/src/api/endpoints/workspaces/index.ts +0 -3
  143. package/src/api/endpoints/workspaces/workspace-invites.ts +0 -34
  144. package/src/api/endpoints/workspaces/workspace-members.ts +0 -31
  145. package/src/api/endpoints/workspaces/workspaces.ts +0 -47
  146. package/src/api/index.ts +0 -6
  147. package/src/api/payloads/design-systems/index.ts +0 -2
  148. package/src/api/payloads/design-systems/update-design-system.ts +0 -29
  149. package/src/api/payloads/design-systems/version.ts +0 -29
  150. package/src/api/payloads/documentation/block-definitions.ts +0 -12
  151. package/src/api/payloads/documentation/design-data-doc-diff.ts +0 -7
  152. package/src/api/payloads/documentation/index.ts +0 -2
  153. package/src/api/payloads/export/index.ts +0 -1
  154. package/src/api/payloads/export/pipeline.ts +0 -50
  155. package/src/api/payloads/index.ts +0 -6
  156. package/src/api/payloads/liveblocks/auth.ts +0 -7
  157. package/src/api/payloads/liveblocks/index.ts +0 -1
  158. package/src/api/payloads/users/index.ts +0 -2
  159. package/src/api/payloads/users/notifications/index.ts +0 -1
  160. package/src/api/payloads/users/notifications/notification-settings.ts +0 -17
  161. package/src/api/payloads/users/profile/index.ts +0 -1
  162. package/src/api/payloads/users/profile/update.ts +0 -4
  163. package/src/api/payloads/workspaces/index.ts +0 -3
  164. package/src/api/payloads/workspaces/transfer-ownership.ts +0 -7
  165. package/src/api/payloads/workspaces/workspace-configuration.ts +0 -50
  166. package/src/api/payloads/workspaces/workspace-integrations.ts +0 -26
  167. package/src/api/transport/index.ts +0 -2
  168. package/src/api/transport/request-executor-error.ts +0 -66
  169. package/src/api/transport/request-executor.ts +0 -87
  170. package/src/index.ts +0 -3
  171. package/src/utils/figma.ts +0 -53
  172. package/src/utils/hash.ts +0 -62
  173. package/src/utils/index.ts +0 -3
  174. package/src/utils/query.ts +0 -18
  175. package/src/yjs/design-system-content/documentation-hierarchy.ts +0 -35
  176. package/src/yjs/design-system-content/index.ts +0 -2
  177. package/src/yjs/design-system-content/item-configuration.ts +0 -93
  178. package/src/yjs/docs-editor/blocks-to-prosemirror.ts +0 -764
  179. package/src/yjs/docs-editor/index.ts +0 -7
  180. package/src/yjs/docs-editor/list-tree-builder.ts +0 -127
  181. package/src/yjs/docs-editor/mock.ts +0 -2104
  182. package/src/yjs/docs-editor/model/block.ts +0 -8
  183. package/src/yjs/docs-editor/model/index.ts +0 -2
  184. package/src/yjs/docs-editor/model/page.ts +0 -8
  185. package/src/yjs/docs-editor/prosemirror/index.ts +0 -3
  186. package/src/yjs/docs-editor/prosemirror/inner-editor-schema.ts +0 -145
  187. package/src/yjs/docs-editor/prosemirror/main-editor-schema.ts +0 -577
  188. package/src/yjs/docs-editor/prosemirror/types.ts +0 -19
  189. package/src/yjs/docs-editor/prosemirror-to-blocks.ts +0 -975
  190. package/src/yjs/docs-editor/utils.ts +0 -115
  191. package/src/yjs/index.ts +0 -3
  192. package/src/yjs/version-room/backend.ts +0 -78
  193. package/src/yjs/version-room/base.ts +0 -211
  194. package/src/yjs/version-room/frontend.ts +0 -461
  195. package/src/yjs/version-room/index.ts +0 -4
  196. package/src/yjs/version-room/utils.ts +0 -109
@@ -1,106 +0,0 @@
1
- import { FigmaNodeReference, FigmaNodeRenderFormat } from "@supernova-studio/model";
2
- import { z } from "zod";
3
-
4
- //
5
- // Enums
6
- //
7
-
8
- export const DTOFigmaNodeRenderFormat = FigmaNodeRenderFormat;
9
- export type DTOFigmaNodeRenderFormat = z.infer<typeof DTOFigmaNodeRenderFormat>;
10
-
11
- //
12
- // Read
13
- //
14
-
15
- export const DTOFigmaNodeOrigin = z.object({
16
- sourceId: z.string(),
17
- fileId: z.string().optional(),
18
- parentName: z.string().optional(),
19
- });
20
-
21
- export const DTOFigmaNodeData = z.object({
22
- // Id of the node in the Figma file
23
- figmaNodeId: z.string(),
24
-
25
- // Validity
26
- isValid: z.boolean(),
27
-
28
- // Asset data
29
- assetId: z.string(),
30
- assetUrl: z.string(),
31
- assetFormat: DTOFigmaNodeRenderFormat,
32
-
33
- // Asset metadata
34
- assetScale: z.number(),
35
- assetWidth: z.number().optional(),
36
- assetHeight: z.number().optional(),
37
- });
38
-
39
- export const DTOFigmaNode = FigmaNodeReference.omit({
40
- data: true,
41
- origin: true,
42
- }).extend({
43
- data: DTOFigmaNodeData,
44
- origin: DTOFigmaNodeOrigin,
45
- });
46
-
47
- export type DTOFigmaNodeOrigin = z.infer<typeof DTOFigmaNodeOrigin>;
48
- export type DTOFigmaNodeData = z.infer<typeof DTOFigmaNodeData>;
49
- export type DTOFigmaNode = z.infer<typeof DTOFigmaNode>;
50
-
51
- //
52
- // Write
53
- //
54
-
55
- /**
56
- * Properties that are available on all types of Figma node render requests
57
- */
58
- const DTOFigmaNodeRenderInputBase = z.object({
59
- /**
60
- * Format in which the node must be rendered, png by default.
61
- */
62
- format: FigmaNodeRenderFormat.default("Png"),
63
- });
64
-
65
- /**
66
- * Figma node render request that uses source ID + node ID to identify the requested
67
- * node to render. The node ID can be obtained from the source's Figma node structure.
68
- */
69
- const DTOFigmaNodeRenderIdInput = DTOFigmaNodeRenderInputBase.extend({
70
- inputType: z
71
- .literal("NodeId")
72
- .optional()
73
- .transform(v => v ?? "NodeId"),
74
-
75
- /**
76
- * Id of a design system's data source representing a linked Figma file
77
- */
78
- sourceId: z.string(),
79
-
80
- /**
81
- * Id of a node within the Figma file
82
- */
83
- figmaFileNodeId: z.string(),
84
- });
85
-
86
- /**
87
- * Figma node render request that uses Figma URL to identify the requested
88
- * node to render. The URL can be obtained by the user directly from the Figma app.
89
- */
90
- const DTOFigmaNodeRenderUrlInput = DTOFigmaNodeRenderInputBase.extend({
91
- inputType: z.literal("URL"),
92
-
93
- /**
94
- * Id of a design system's data source representing a linked Figma file
95
- */
96
- figmaNodeUrl: z.string(),
97
- });
98
-
99
- export const DTOFigmaNodeRenderInput = z.discriminatedUnion("inputType", [
100
- DTOFigmaNodeRenderIdInput,
101
- DTOFigmaNodeRenderUrlInput,
102
- ]);
103
-
104
- export type DTOFigmaNodeRenderIdInput = z.infer<typeof DTOFigmaNodeRenderIdInput>;
105
- export type DTOFigmaNodeRenderUrlInput = z.infer<typeof DTOFigmaNodeRenderUrlInput>;
106
- export type DTOFigmaNodeRenderInput = z.infer<typeof DTOFigmaNodeRenderInput>;
@@ -1,2 +0,0 @@
1
- export * from "./figma-node";
2
- export * from "./node-actions-v2";
@@ -1,24 +0,0 @@
1
- import { z } from "zod";
2
- import { DTOFigmaNode, DTOFigmaNodeRenderInput } from "./figma-node";
3
-
4
- //
5
- // Read
6
- //
7
-
8
- export const DTOFigmaNodeRenderActionOutput = z.object({
9
- type: z.literal("FigmaNodeRender"),
10
- figmaNodes: z.array(DTOFigmaNode),
11
- });
12
-
13
- export type DTOFigmaNodeRenderActionOutput = z.infer<typeof DTOFigmaNodeRenderActionOutput>;
14
-
15
- //
16
- // Read
17
- //
18
-
19
- export const DTOFigmaNodeRenderActionInput = z.object({
20
- type: z.literal("FigmaNodeRender"),
21
- input: DTOFigmaNodeRenderInput.array(),
22
- });
23
-
24
- export type DTOFigmaNodeRenderActionInput = z.infer<typeof DTOFigmaNodeRenderActionInput>;
@@ -1,17 +0,0 @@
1
- import { FigmaFileStructureOrigin, FigmaFileStructureStatistics } from "@supernova-studio/model";
2
- import { z } from "zod";
3
-
4
- export const DTOFrameNodeStructure = z.object({
5
- id: z.string(),
6
- persistentId: z.string(),
7
- designSystemVersionId: z.string(),
8
- origin: FigmaFileStructureOrigin,
9
- assetsInFile: FigmaFileStructureStatistics,
10
- });
11
-
12
- export const DTOFrameNodeStructureListResponse = z.object({
13
- structures: DTOFrameNodeStructure.array(),
14
- });
15
-
16
- export type DTOFrameNodeStructure = z.infer<typeof DTOFrameNodeStructure>;
17
- export type DTOFrameNodeStructureListResponse = z.infer<typeof DTOFrameNodeStructureListResponse>;
@@ -1 +0,0 @@
1
- export * from "./frame-node-structure";
@@ -1,21 +0,0 @@
1
- import { z } from "zod";
2
- import { DTOFigmaNode } from "./figma-nodes";
3
-
4
- //
5
- // Read
6
- //
7
-
8
- export const DTOElementsGetTypeFilter = z.enum(["FigmaNode"]);
9
-
10
- export const DTOElementsGetQuerySchema = z.object({
11
- types: z.string().transform(val => val.split(",").map(v => DTOElementsGetTypeFilter.parse(v))),
12
- });
13
-
14
- export const DTOElementsGetOutput = z.object({
15
- figmaNodes: z.array(DTOFigmaNode).optional(),
16
- });
17
-
18
- export type DTOElementsGetOutput = z.infer<typeof DTOElementsGetOutput>;
19
- export type DTOElementsGetQueryRaw = z.input<typeof DTOElementsGetQuerySchema>;
20
- export type DTOElementsGetQueryParsed = z.output<typeof DTOElementsGetQuerySchema>;
21
- export type DTOElementsGetTypeFilter = z.infer<typeof DTOElementsGetTypeFilter>;
@@ -1,7 +0,0 @@
1
- export * from "./components";
2
- export * from "./documentation";
3
- export * from "./figma-nodes";
4
- export * from "./frame-node-structures";
5
- export * from "./properties";
6
- export * from "./elements-action-v2";
7
- export * from "./get-elements-v2";
@@ -1,2 +0,0 @@
1
- export * from "./property-definitions";
2
- export * from "./property-values";
@@ -1,75 +0,0 @@
1
- import {
2
- ElementPropertyImmutableType,
3
- ElementPropertyLinkType,
4
- ElementPropertyTargetType,
5
- ElementPropertyTypeSchema,
6
- nullishToOptional,
7
- } from "@supernova-studio/model";
8
- import { z } from "zod";
9
- import { DTOColorTokenInlineData } from "../../aux";
10
- import { DTOObjectMeta } from "../../aux/meta";
11
-
12
- const CODE_NAME_REGEX = /^[a-zA-Z_$][a-zA-Z_$0-9]{1,99}$/;
13
-
14
- export const DTOElementPropertyDefinitionOption = z.object({
15
- id: z.string(),
16
- name: z.string(),
17
- backgroundColor: DTOColorTokenInlineData.optional(),
18
- });
19
-
20
- // DTO Object
21
- export const DTOElementPropertyDefinition = z.object({
22
- id: z.string(),
23
- designSystemVersionId: z.string(),
24
- meta: DTOObjectMeta,
25
- persistentId: z.string(),
26
- type: ElementPropertyTypeSchema,
27
- targetElementType: ElementPropertyTargetType,
28
- codeName: z.string().regex(CODE_NAME_REGEX),
29
- options: nullishToOptional(z.array(DTOElementPropertyDefinitionOption)),
30
- linkElementType: nullishToOptional(ElementPropertyLinkType),
31
- isImmutable: z.boolean(),
32
- immutablePropertyType: ElementPropertyImmutableType.optional(),
33
- });
34
-
35
- export type DTOElementPropertyDefinitionOption = z.infer<typeof DTOElementPropertyDefinitionOption>;
36
- export type DTOElementPropertyDefinition = z.infer<typeof DTOElementPropertyDefinition>;
37
-
38
- //
39
- // Read
40
- //
41
-
42
- export const DTOElementPropertyDefinitionListResponse = z.object({
43
- definitions: z.array(DTOElementPropertyDefinition),
44
- });
45
-
46
- export const DTOElementPropertyDefinitionResponse = z.object({
47
- definition: DTOElementPropertyDefinition,
48
- });
49
-
50
- export type DTOElementPropertyDefinitionListResponse = z.infer<typeof DTOElementPropertyDefinitionListResponse>;
51
- export type DTOElementPropertyDefinitionResponse = z.infer<typeof DTOElementPropertyDefinitionResponse>;
52
-
53
- //
54
- // Write
55
- //
56
-
57
- export const DTOElementPropertyDefinitionCreatePayload = z.object({
58
- meta: DTOObjectMeta,
59
- persistentId: z.string(),
60
- type: ElementPropertyTypeSchema,
61
- targetElementType: ElementPropertyTargetType,
62
- codeName: z.string().regex(CODE_NAME_REGEX),
63
- options: nullishToOptional(z.array(DTOElementPropertyDefinitionOption)),
64
- linkElementType: nullishToOptional(ElementPropertyLinkType),
65
- columnWidth: z.number().max(1024).optional(),
66
- });
67
-
68
- export const DTOElementPropertyDefinitionUpdatePayload = z.object({
69
- meta: DTOObjectMeta.optional(),
70
- codeName: z.string().regex(CODE_NAME_REGEX).optional(),
71
- options: z.array(DTOElementPropertyDefinitionOption).optional(),
72
- });
73
-
74
- export type DTOElementPropertyDefinitionCreatePayload = z.infer<typeof DTOElementPropertyDefinitionCreatePayload>;
75
- export type DTOElementPropertyDefinitionUpdatePayload = z.infer<typeof DTOElementPropertyDefinitionUpdatePayload>;
@@ -1,38 +0,0 @@
1
- import { z } from "zod";
2
-
3
- //
4
- // Read
5
- //
6
-
7
- export const DTOElementPropertyValue = z.object({
8
- id: z.string(),
9
- designSystemVersionId: z.string(),
10
- definitionId: z.string(),
11
- targetElementId: z.string(),
12
- value: z.union([z.string(), z.number(), z.boolean()]).optional(),
13
- valuePreview: z.string().optional(),
14
- });
15
-
16
- export const DTOElementPropertyValueListResponse = z.object({
17
- values: z.array(DTOElementPropertyValue),
18
- });
19
-
20
- export const DTOElementPropertyValueResponse = z.object({
21
- value: DTOElementPropertyValue,
22
- });
23
-
24
- export type DTOElementPropertyValue = z.infer<typeof DTOElementPropertyValue>;
25
- export type DTOElementPropertyValueListResponse = z.infer<typeof DTOElementPropertyValueListResponse>;
26
- export type DTOElementPropertyValueResponse = z.infer<typeof DTOElementPropertyValueResponse>;
27
-
28
- //
29
- // Create
30
- //
31
-
32
- export const DTOElementPropertyValueUpsertPaylod = z.object({
33
- definitionId: z.string(),
34
- targetElementId: z.string(),
35
- value: z.string().or(z.number()).or(z.boolean()),
36
- });
37
-
38
- export type DTOElementPropertyValueUpsertPaylod = z.infer<typeof DTOElementPropertyValueUpsertPaylod>;
@@ -1,95 +0,0 @@
1
- import { z } from "zod";
2
-
3
- //
4
- // Primitives
5
- //
6
-
7
- const PrimitiveValue = z.number().or(z.boolean()).or(z.string());
8
- const ArrayValue = z.array(z.string());
9
- const ObjectValue = z.record(z.string());
10
-
11
- export const DTOExporterPropertyDefinitionValue = PrimitiveValue.or(ArrayValue).or(ObjectValue);
12
- export const DTOExporterPropertyType = z.enum(["Enum", "Boolean", "String", "Number", "Array", "Object"]);
13
-
14
- export type DTOExporterPropertyDefinitionValue = z.infer<typeof DTOExporterPropertyDefinitionValue>;
15
- export type DTOExporterPropertyType = z.infer<typeof DTOExporterPropertyType>;
16
-
17
- //
18
- // Property
19
- //
20
-
21
- const PropertyDefinitionBase = z.object({
22
- key: z.string(),
23
- title: z.string(),
24
- description: z.string(),
25
- });
26
-
27
- export const DTOExporterPropertyDefinitionEnum = PropertyDefinitionBase.extend({
28
- type: z.literal(DTOExporterPropertyType.Enum.Enum),
29
- options: z.string().array(),
30
- default: z.string(),
31
- });
32
-
33
- export const DTOExporterPropertyDefinitionBoolean = PropertyDefinitionBase.extend({
34
- type: z.literal(DTOExporterPropertyType.Enum.Boolean),
35
- default: z.boolean(),
36
- });
37
-
38
- export const DTOExporterPropertyDefinitionString = PropertyDefinitionBase.extend({
39
- type: z.literal(DTOExporterPropertyType.Enum.String),
40
- default: z.string(),
41
- });
42
-
43
- export const DTOExporterPropertyDefinitionNumber = PropertyDefinitionBase.extend({
44
- type: z.literal(DTOExporterPropertyType.Enum.Number),
45
- default: z.number(),
46
- });
47
-
48
- export const DTOExporterPropertyDefinitionArray = PropertyDefinitionBase.extend({
49
- type: z.literal(DTOExporterPropertyType.Enum.Array),
50
- default: ArrayValue,
51
- });
52
-
53
- export const DTOExporterPropertyDefinitionObject = PropertyDefinitionBase.extend({
54
- type: z.literal(DTOExporterPropertyType.Enum.Object),
55
- default: ObjectValue,
56
- allowedKeys: z
57
- .object({
58
- options: z.string().array(),
59
- })
60
- .optional(),
61
- allowedValues: z
62
- .object({
63
- options: z.string().array(),
64
- })
65
- .optional(),
66
- });
67
-
68
- export const DTOExporterPropertyDefinition = z.discriminatedUnion("type", [
69
- DTOExporterPropertyDefinitionEnum,
70
- DTOExporterPropertyDefinitionBoolean,
71
- DTOExporterPropertyDefinitionString,
72
- DTOExporterPropertyDefinitionNumber,
73
- DTOExporterPropertyDefinitionArray,
74
- DTOExporterPropertyDefinitionObject,
75
- ]);
76
-
77
- export const DTOExporterPropertyDefinitionsResponse = z.object({
78
- properties: DTOExporterPropertyDefinition.array(),
79
- });
80
-
81
- export type DTOExporterPropertyDefinitionEnum = z.infer<typeof DTOExporterPropertyDefinitionEnum>;
82
- export type DTOExporterPropertyDefinitionBoolean = z.infer<typeof DTOExporterPropertyDefinitionBoolean>;
83
- export type DTOExporterPropertyDefinitionString = z.infer<typeof DTOExporterPropertyDefinitionString>;
84
- export type DTOExporterPropertyDefinitionNumber = z.infer<typeof DTOExporterPropertyDefinitionNumber>;
85
- export type DTOExporterPropertyDefinitionArray = z.infer<typeof DTOExporterPropertyDefinitionArray>;
86
- export type DTOExporterPropertyDefinitionObject = z.infer<typeof DTOExporterPropertyDefinitionObject>;
87
- export type DTOExporterPropertyDefinition = z.infer<typeof DTOExporterPropertyDefinition>;
88
- export type DTOExporterPropertyDefinitionsResponse = z.infer<typeof DTOExporterPropertyDefinitionsResponse>;
89
-
90
- //
91
- // Value
92
- //
93
-
94
- export const DTOExporterPropertyDefinitionValueMap = z.record(DTOExporterPropertyDefinitionValue);
95
- export type DTOExporterPropertyDefinitionValueMap = z.infer<typeof DTOExporterPropertyDefinitionValueMap>;
@@ -1,87 +0,0 @@
1
- import {
2
- nullishToOptional,
3
- PulsarContributionConfigurationProperty,
4
- PulsarContributionVariant,
5
- PulsarCustomBlock,
6
- } from "@supernova-studio/model";
7
- import { z } from "zod";
8
- import { DTOExporterPropertyDefinition } from "./exporter-property";
9
-
10
- //
11
- // Read
12
- //
13
-
14
- export const DTOExporterType = z.enum(["documentation", "code"]);
15
- export const DTOExporterSource = z.enum(["git", "upload"]);
16
- export const DTOExporterMembershipRole = z.enum(["Owner", "OwnerArchived", "User"]);
17
-
18
- export const DTOExporterListQuery = z.object({
19
- limit: z.coerce.number().optional(),
20
- });
21
-
22
- export const DTOExporter = z.object({
23
- id: z.string(),
24
- name: z.string(),
25
- isPrivate: z.boolean(),
26
- exporterType: DTOExporterType,
27
- isDefaultDocumentationExporter: z.boolean(),
28
-
29
- iconURL: z.string().optional(),
30
- configurationProperties: PulsarContributionConfigurationProperty.array(),
31
- properties: DTOExporterPropertyDefinition.array().optional(),
32
- customBlocks: PulsarCustomBlock.array(),
33
- blockVariants: z.record(z.string(), PulsarContributionVariant.array()),
34
-
35
- usesBrands: z.boolean(),
36
- usesThemes: z.boolean(),
37
-
38
- source: DTOExporterSource,
39
-
40
- gitUrl: nullishToOptional(z.string()),
41
- gitBranch: nullishToOptional(z.string()),
42
- gitDirectory: nullishToOptional(z.string()),
43
- });
44
-
45
- export const DTOExporterMembership = z.object({
46
- workspaceId: z.string(),
47
- exporterId: z.string(),
48
- role: DTOExporterMembershipRole,
49
- });
50
-
51
- export const DTOExporterCreateOutput = z.object({
52
- exporter: DTOExporter,
53
- membership: DTOExporterMembership,
54
- });
55
-
56
- export const DTOExporterListResponse = z.object({
57
- exporters: DTOExporter.array(),
58
- membership: DTOExporterMembership.array(),
59
- });
60
-
61
- export type DTOExporterListQuery = z.infer<typeof DTOExporterListQuery>;
62
- export type DTOExporterType = z.infer<typeof DTOExporterType>;
63
- export type DTOExporterSource = z.infer<typeof DTOExporterSource>;
64
- export type DTOExporterMembershipRole = z.infer<typeof DTOExporterMembershipRole>;
65
- export type DTOExporter = z.infer<typeof DTOExporter>;
66
- export type DTOExporterMembership = z.infer<typeof DTOExporterMembership>;
67
- export type DTOExporterCreateOutput = z.infer<typeof DTOExporterCreateOutput>;
68
- export type DTOExporterListResponse = z.infer<typeof DTOExporterListResponse>;
69
-
70
- //
71
- // Write
72
- //
73
-
74
- export const DTOExporterGitProviderEnum = z.enum(["github", "gitlab", "bitbucket", "azure"]);
75
-
76
- export const DTOExporterCreateInput = z.object({
77
- url: z.string(),
78
- provider: DTOExporterGitProviderEnum,
79
- });
80
-
81
- export const DTOExporterUpdateInput = z.object({
82
- url: z.string().optional(),
83
- });
84
-
85
- export type DTOExporterGitProviderEnum = z.infer<typeof DTOExporterGitProviderEnum>;
86
- export type DTOExporterCreateInput = z.infer<typeof DTOExporterCreateInput>;
87
- export type DTOExporterUpdateInput = z.infer<typeof DTOExporterUpdateInput>;
@@ -1,6 +0,0 @@
1
- import { ExportJobFindByFilter } from "@supernova-studio/model";
2
- import { z } from "zod";
3
-
4
- export const DTOExportJobsListFilter = ExportJobFindByFilter;
5
-
6
- export type DTOExportJobsListFilter = z.infer<typeof DTOExportJobsListFilter>;
@@ -1,5 +0,0 @@
1
- export * from "./exporter-property";
2
- export * from "./exporter";
3
- export * from "./filter";
4
- export * from "./job";
5
- export * from "./pipeline";
@@ -1,87 +0,0 @@
1
- import {
2
- ExportJobDocsDestinationResult,
3
- ExportJobResult,
4
- ExportJobStatus,
5
- ExporterDestinationAzure,
6
- ExporterDestinationBitbucket,
7
- ExporterDestinationDocs,
8
- ExporterDestinationGithub,
9
- ExporterDestinationGitlab,
10
- ExporterDestinationS3,
11
- ObjectMeta,
12
- } from "@supernova-studio/model";
13
- import { z } from "zod";
14
- import { DTOExporterPropertyDefinitionValueMap } from "./exporter-property";
15
-
16
- export const DTOExportJobCreatedBy = z.object({
17
- userId: z.string(),
18
- userName: z.string(),
19
- });
20
-
21
- export const DTOExportJobDesignSystemPreview = z.object({
22
- id: z.string(),
23
- meta: ObjectMeta,
24
- });
25
-
26
- export const DTOExportJobDesignSystemVersionPreview = z.object({
27
- id: z.string(),
28
- meta: ObjectMeta,
29
- version: z.string(),
30
- isReadonly: z.boolean(),
31
- });
32
-
33
- export const DTOExportJobDestinations = z.object({
34
- s3: ExporterDestinationS3.optional(),
35
- azure: ExporterDestinationAzure.optional(),
36
- bitbucket: ExporterDestinationBitbucket.optional(),
37
- github: ExporterDestinationGithub.optional(),
38
- gitlab: ExporterDestinationGitlab.optional(),
39
- documentation: ExporterDestinationDocs.optional(),
40
- webhookUrl: z.string().optional(),
41
- });
42
-
43
- export const DTOExportJobResult = ExportJobResult.omit({
44
- sndocs: true,
45
- }).extend({
46
- documentation: ExportJobDocsDestinationResult.optional(),
47
- });
48
-
49
- export const DTOExportJob = z.object({
50
- id: z.string(),
51
-
52
- createdAt: z.coerce.date(),
53
- finishedAt: z.coerce.date().optional(),
54
-
55
- index: z.number().optional(),
56
- status: ExportJobStatus,
57
- estimatedExecutionTime: z.number().optional(),
58
-
59
- createdBy: DTOExportJobCreatedBy.optional(),
60
- designSystem: DTOExportJobDesignSystemPreview,
61
- designSystemVersion: DTOExportJobDesignSystemVersionPreview,
62
-
63
- destinations: DTOExportJobDestinations,
64
-
65
- exporterId: z.string(),
66
- scheduleId: z.string().optional(),
67
-
68
- result: DTOExportJobResult.optional(),
69
-
70
- brandPersistentId: z.string().optional(),
71
- themePersistentId: z.string().optional(),
72
- themePersistentIds: z.string().array().optional(),
73
-
74
- exporterConfiguration: DTOExporterPropertyDefinitionValueMap.optional(),
75
- });
76
-
77
- export const DTOExportJobResponse = z.object({
78
- job: DTOExportJob,
79
- });
80
-
81
- export type DTOExportJobCreatedBy = z.infer<typeof DTOExportJobCreatedBy>;
82
- export type DTOExportJobDesignSystemPreview = z.infer<typeof DTOExportJobDesignSystemPreview>;
83
- export type DTOExportJobDesignSystemVersionPreview = z.infer<typeof DTOExportJobDesignSystemVersionPreview>;
84
- export type DTOExportJobDestinations = z.infer<typeof DTOExportJobDestinations>;
85
- export type DTOExportJobResult = z.infer<typeof DTOExportJobResult>;
86
- export type DTOExportJob = z.infer<typeof DTOExportJob>;
87
- export type DTOExportJobResponse = z.infer<typeof DTOExportJobResponse>;
@@ -1,43 +0,0 @@
1
- import { ExportDestinationsMap, PipelineEventType } from "@supernova-studio/model";
2
- import { z } from "zod";
3
- import { DTOExporterPropertyDefinitionValueMap } from "./exporter-property";
4
- import { DTOExportJob } from "./job";
5
-
6
- export const DTOPipelineListQuery = z.object({
7
- designSystemId: z.string().optional(),
8
- exporterId: z.string().optional(),
9
- latestJobsLimit: z.coerce.number().optional(),
10
- });
11
-
12
- export const DTOPipeline = z.object({
13
- id: z.string(),
14
- name: z.string(),
15
- eventType: PipelineEventType,
16
- isEnabled: z.boolean(),
17
- workspaceId: z.string(),
18
- designSystemId: z.string(),
19
- exporterId: z.string(),
20
- brandPersistentId: z.string().optional(),
21
-
22
- themePersistentId: z.string().optional(),
23
- themePersistentIds: z.string().array().optional(),
24
-
25
- exporterConfiguration: DTOExporterPropertyDefinitionValueMap.optional(),
26
-
27
- ...ExportDestinationsMap.shape,
28
-
29
- latestJobs: DTOExportJob.array(),
30
- });
31
-
32
- export const DTOPipelineListResponse = z.object({
33
- pipelines: DTOPipeline.array(),
34
- });
35
-
36
- export const DTOPipelineResponse = z.object({
37
- pipeline: DTOPipeline,
38
- });
39
-
40
- export type DTOPipelineListQuery = z.infer<typeof DTOPipelineListQuery>;
41
- export type DTOPipeline = z.infer<typeof DTOPipeline>;
42
- export type DTOPipelineResponse = z.infer<typeof DTOPipelineResponse>;
43
- export type DTOPipelineListResponse = z.infer<typeof DTOPipelineListResponse>;
@@ -1,30 +0,0 @@
1
- import { z } from "zod";
2
-
3
- export const DTOAssetRenderConfiguration = z.object({
4
- prefix: z.string().optional(),
5
- suffix: z.string().optional(),
6
- scale: z.enum(["x1", "x2", "x3", "x4"]),
7
- format: z.enum(["png", "pdf", "svg"]),
8
- });
9
-
10
- export const DTORenderedAssetFile = z.object({
11
- assetId: z.string(),
12
- fileName: z.string(),
13
- sourceUrl: z.string(),
14
- settings: DTOAssetRenderConfiguration,
15
- originalName: z.string(),
16
- });
17
-
18
- export const DTODownloadAssetsRequest = z.object({
19
- persistentIds: z.array(z.string().uuid()).optional(),
20
- settings: DTOAssetRenderConfiguration.array(),
21
- });
22
-
23
- export const DTODownloadAssetsResponse = z.object({
24
- items: DTORenderedAssetFile.array(),
25
- });
26
-
27
- export type DTOAssetRenderConfiguration = z.infer<typeof DTOAssetRenderConfiguration>;
28
- export type DTORenderedAssetFile = z.infer<typeof DTORenderedAssetFile>;
29
- export type DTODownloadAssetsRequest = z.infer<typeof DTODownloadAssetsRequest>;
30
- export type DTODownloadAssetsResponse = z.infer<typeof DTODownloadAssetsResponse>;
@@ -1 +0,0 @@
1
- export * from "./download";
@@ -1 +0,0 @@
1
- export * from "./assets";