@supernova-studio/supernova-sdk-beta 2.4.6 → 2.4.11

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 (99) hide show
  1. package/build/supernova-sdk-typescript.js +1 -1
  2. package/build/supernova-sdk-typescript.js.map +1 -1
  3. package/build/types/core/SDKSupernova.d.ts +9 -0
  4. package/build/types/core/areas/SDKAreaActivityEvents.d.ts +7 -0
  5. package/build/types/core/areas/SDKAreaAgentChats.d.ts +12 -0
  6. package/build/types/core/areas/SDKAreaBulkOperations.d.ts +76 -74
  7. package/build/types/core/areas/SDKAreaDataSources.d.ts +1 -1
  8. package/build/types/core/areas/SDKAreaDesignSystems.d.ts +13 -13
  9. package/build/types/core/areas/SDKAreaDocumentation.d.ts +304 -289
  10. package/build/types/core/areas/SDKAreaImport.d.ts +35 -0
  11. package/build/types/core/areas/SDKAreaMCP.d.ts +26 -1
  12. package/build/types/core/areas/SDKAreaProjects.d.ts +1084 -1100
  13. package/build/types/core/areas/SDKAreaRawData.d.ts +1040 -1039
  14. package/build/types/core/areas/SDKAreaResources.d.ts +90 -90
  15. package/build/types/core/areas/SDKAreaSanboxes.d.ts +9 -9
  16. package/build/types/core/areas/SDKAreaThreads.d.ts +67 -67
  17. package/build/types/core/areas/SDKAreaTokens.d.ts +17 -12
  18. package/build/types/core/areas/SDKAreaWorkspaces.d.ts +1 -1
  19. package/build/types/core/data/SDKDataCore.d.ts +1771 -1746
  20. package/build/types/core/data/SDKDataCoreCached.d.ts +2 -2
  21. package/build/types/core/data/requests/SDKDataCoreReadRequests.d.ts +647 -593
  22. package/build/types/core/data/requests/SDKDataCoreWriteRequests.d.ts +2515 -2489
  23. package/build/types/core/resolvers/SDKDocsEntityItemResolver.d.ts +121 -121
  24. package/build/types/core/resolvers/SDKSnapshotTokenBuilder.d.ts +28 -0
  25. package/build/types/core/resolvers/SDKTokenResolver.d.ts +11 -9
  26. package/build/types/exports.d.ts +19 -11
  27. package/build/types/model/activity-events/SDKActivityEvent.d.ts +49 -0
  28. package/build/types/model/agent-chats/SDKAgentChat.d.ts +31 -0
  29. package/build/types/model/base/SDKDesignSystem.d.ts +3 -1
  30. package/build/types/model/datasets/SDKDataset.d.ts +15 -5
  31. package/build/types/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +4 -1
  32. package/build/types/model/docs/blocks/definition/actual/context-mcp/SDKDocsBlockActualContextMcp.d.ts +2 -0
  33. package/build/types/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +7 -24
  34. package/build/types/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +3 -2
  35. package/build/types/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +3 -2
  36. package/build/types/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +3 -6
  37. package/build/types/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +3 -8
  38. package/build/types/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +3 -3
  39. package/build/types/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +7 -10
  40. package/build/types/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +3 -2
  41. package/build/types/model/docs/blocks/properties/SDKDocsBlockContextProperty.d.ts +16 -0
  42. package/build/types/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +3 -2
  43. package/build/types/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +3 -6
  44. package/build/types/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +7 -26
  45. package/build/types/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +7 -22
  46. package/build/types/model/docs/blocks/properties/SDKDocsBlockFileProperty.d.ts +4 -9
  47. package/build/types/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +3 -10
  48. package/build/types/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +3 -2
  49. package/build/types/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +3 -3
  50. package/build/types/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +3 -2
  51. package/build/types/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +3 -2
  52. package/build/types/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +3 -3
  53. package/build/types/model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty.d.ts +3 -3
  54. package/build/types/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -7
  55. package/build/types/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +3 -2
  56. package/build/types/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +4 -22
  57. package/build/types/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +12 -28
  58. package/build/types/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +3 -2
  59. package/build/types/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +7 -31
  60. package/build/types/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +3 -2
  61. package/build/types/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +3 -3
  62. package/build/types/model/docs/blocks/properties/SDKDocsBlockUrlProperty.d.ts +3 -2
  63. package/build/types/model/docs/sections/SDKDocsSection.d.ts +0 -31
  64. package/build/types/model/documentation/SDKPageHistoryVersion.d.ts +20 -0
  65. package/build/types/model/documentation/blocks/SDKDocumentationLegacyPageBlockContextMcp.d.ts +11 -0
  66. package/build/types/model/elements/SDKElementPropertyOption.d.ts +1 -2
  67. package/build/types/model/enums/SDKCodeLanguage.d.ts +1 -1
  68. package/build/types/model/enums/SDKDesignSystemRole.d.ts +1 -2
  69. package/build/types/model/enums/SDKDocsBlockBehaviorSelectionType.d.ts +4 -2
  70. package/build/types/model/enums/SDKDocsBlockContainerSize.d.ts +6 -4
  71. package/build/types/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
  72. package/build/types/model/enums/SDKDocumentationLegacyPageBlockType.d.ts +1 -0
  73. package/build/types/model/enums/SDKTokenType.d.ts +2 -0
  74. package/build/types/model/enums/SDKWorkspaceSeatType.d.ts +14 -3
  75. package/build/types/model/exporters/SDKExporter.d.ts +2 -2
  76. package/build/types/model/exporters/SDKPipeline.d.ts +1 -1
  77. package/build/types/model/membership/SDKMembership.d.ts +1 -1
  78. package/build/types/model/support/SDKSource.d.ts +4 -3
  79. package/build/types/model/themes/SDKTokenThemeOverride.d.ts +1 -0
  80. package/build/types/model/tokens/remote/SDKRemoteTokenModel.d.ts +34 -1
  81. package/build/types/model/tokens/remote/SDKRemoteTokenValue.d.ts +1 -1
  82. package/build/types/model/workspaces/SDKWorkspaceProductPrice.d.ts +6 -3
  83. package/build/types/model/workspaces/SDKWorkspaceSubscription.d.ts +2 -6
  84. package/build/types/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +6 -3
  85. package/build/types/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +29 -3
  86. package/build/types/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +2 -0
  87. package/build/types/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +31 -0
  88. package/build/types/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +2 -0
  89. package/build/types/tools/design-tokens/utilities/unresolvable-modes/index.d.ts +4 -0
  90. package/build/types/tools/design-tokens/utilities/unresolvable-modes/lenient-resolve.d.ts +2 -0
  91. package/build/types/tools/design-tokens/utilities/unresolvable-modes/placeholder.d.ts +2 -0
  92. package/build/types/tools/design-tokens/utilities/unresolvable-modes/preserve.d.ts +2 -0
  93. package/build/types/tools/design-tokens/utilities/unresolvable-modes/strict.d.ts +2 -0
  94. package/build/types/tools/design-tokens/utilities/unresolvable-modes/types.d.ts +33 -0
  95. package/build/types/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +9 -0
  96. package/build/types/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
  97. package/build/types/utils/TokenUtils.d.ts +1 -1
  98. package/package.json +17 -21
  99. package/build/types/model/enums/SDKDocsBlockTokenNameFormat.d.ts +0 -10
@@ -1,3 +1,5 @@
1
+ import { AreaActivityEvents } from "./areas/SDKAreaActivityEvents";
2
+ import { AreaAgentChats } from "./areas/SDKAreaAgentChats";
1
3
  import { AreaAssets } from "./areas/SDKAreaAssets";
2
4
  import { AreaAutomation } from "./areas/SDKAreaAutomation";
3
5
  import { AreaBrands } from "./areas/SDKAreaBrands";
@@ -9,6 +11,7 @@ import { AreaDataSources } from "./areas/SDKAreaDataSources";
9
11
  import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
10
12
  import { AreaDocsAnalytics } from "./areas/SDKAreaDocsAnalytics";
11
13
  import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
14
+ import { SDKAreaImport } from "./areas/SDKAreaImport";
12
15
  import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
13
16
  import { AreaMCP } from "./areas/SDKAreaMCP";
14
17
  import { AreaMe } from "./areas/SDKAreaMe";
@@ -62,6 +65,8 @@ export declare class Supernova {
62
65
  resources: AreaResources;
63
66
  /** Get, create, update, manipulate or delete documentation items */
64
67
  documentation: AreaDocumentation;
68
+ /** Validate and import markdown into documentation pages */
69
+ import: SDKAreaImport;
65
70
  /** Get published documentation items */
66
71
  docsAnalytics: AreaDocsAnalytics;
67
72
  /** Get, create, update, manipulate or delete pipelines and automation jobs */
@@ -92,6 +97,10 @@ export declare class Supernova {
92
97
  messaging: AreaMessaging;
93
98
  /** Get, create, update, manipulate or delete sandboxes */
94
99
  sandboxes: AreaSandboxes;
100
+ /** Get activity events */
101
+ activityEvents: AreaActivityEvents;
102
+ /** Get, create, update, archive or delete agent chats */
103
+ agentChats: AreaAgentChats;
95
104
  /** Get access to raw data for local-only restoration of data */
96
105
  raw: AreaRawData;
97
106
  /**
@@ -0,0 +1,7 @@
1
+ import { ActivityEventListFilter, ActivityEventListResult } from "../../model/activity-events/SDKActivityEvent";
2
+ import { DataCore } from "../data/SDKDataCore";
3
+ export declare class AreaActivityEvents {
4
+ private dataCore;
5
+ constructor(dataCore: DataCore);
6
+ list(filter: ActivityEventListFilter): Promise<ActivityEventListResult>;
7
+ }
@@ -0,0 +1,12 @@
1
+ import type { AgentChat, AgentChatChangedEntity, AgentChatCreateInput, AgentChatDeleteResponse, AgentChatListFilter, AgentChatUpdateInput } from "../../model/agent-chats/SDKAgentChat";
2
+ import { DataCore } from "../data/SDKDataCore";
3
+ export declare class AreaAgentChats {
4
+ private dataCore;
5
+ constructor(dataCore: DataCore);
6
+ list(filter: AgentChatListFilter): Promise<AgentChat[]>;
7
+ getByEveSession(eveSessionId: string): Promise<AgentChat>;
8
+ listChangedEntities(chatId: string): Promise<AgentChatChangedEntity[]>;
9
+ create(input: AgentChatCreateInput): Promise<AgentChat>;
10
+ update(chatId: string, input: AgentChatUpdateInput): Promise<AgentChat>;
11
+ delete(chatId: string): Promise<AgentChatDeleteResponse>;
12
+ }
@@ -53,9 +53,11 @@ export declare class AreaBulkOperations {
53
53
  * @returns Nothing
54
54
  */
55
55
  importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", payload: unknown, isTokenTypeSplitEnabled?: boolean, version?: "1" | "2"): Promise<ImportJob>;
56
- /** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
56
+ /** Updates or creates token data in Supernova using the aggregated token endpoint. Token fields, its group, theme overrides and property values all travel in one request, which also records a single activity event for the change.
57
57
  *
58
- * WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
58
+ * WARNING: Not atomic. The server applies the parts of the payload in sequence, so a failure can leave earlier parts already written.
59
+ *
60
+ * In `create` mode, `data.token` has its `id` and `idInVersion` written back from the server response.
59
61
  * @param to - Remote version to write to
60
62
  * @param data - Update information. All keys except token and its parent are optional and any combination of optional properties is allowed.
61
63
  * @returns Nothing
@@ -69,126 +71,126 @@ export declare class AreaBulkOperations {
69
71
  */
70
72
  /** Bulk update properties */
71
73
  updateElementProperties(to: RemoteVersionIdentifier, data: DTOElementPropertyValuesEditActionInput["values"]): Promise<{
72
- type?: "DocumentationPageCreate";
73
- output?: {
74
- success?: true;
74
+ type: "DocumentationPageCreate";
75
+ output: {
76
+ success: true;
75
77
  };
76
78
  } | {
77
- type?: "DocumentationPageUpdate";
78
- output?: {
79
- success?: true;
79
+ type: "DocumentationPageUpdate";
80
+ output: {
81
+ success: true;
80
82
  };
81
83
  } | {
82
- type?: "DocumentationPageUpdateDocument";
83
- output?: {
84
- success?: true;
84
+ type: "DocumentationPageUpdateDocument";
85
+ output: {
86
+ success: true;
85
87
  };
86
88
  } | {
87
- type?: "DocumentationPageMove";
88
- output?: {
89
- success?: true;
89
+ type: "DocumentationPageMove";
90
+ output: {
91
+ success: true;
90
92
  };
91
93
  } | {
92
- type?: "DocumentationPageDuplicate";
93
- output?: {
94
- success?: true;
94
+ type: "DocumentationPageDuplicate";
95
+ output: {
96
+ success: true;
95
97
  };
96
98
  } | {
97
- type?: "DocumentationPageDelete";
98
- output?: {
99
- success?: true;
99
+ type: "DocumentationPageDelete";
100
+ output: {
101
+ success: true;
100
102
  };
101
103
  } | {
102
- type?: "DocumentationGroupCreate";
103
- output?: {
104
- success?: true;
104
+ type: "DocumentationGroupCreate";
105
+ output: {
106
+ success: true;
105
107
  };
106
108
  } | {
107
- type?: "DocumentationTabCreate";
108
- output?: {
109
- success?: true;
109
+ type: "DocumentationTabCreate";
110
+ output: {
111
+ success: true;
110
112
  };
111
113
  } | {
112
- type?: "DocumentationGroupUpdate";
113
- output?: {
114
- success?: true;
114
+ type: "DocumentationGroupUpdate";
115
+ output: {
116
+ success: true;
115
117
  };
116
118
  } | {
117
- type?: "DocumentationGroupMove";
118
- output?: {
119
- success?: true;
119
+ type: "DocumentationGroupMove";
120
+ output: {
121
+ success: true;
120
122
  };
121
123
  } | {
122
- type?: "DocumentationGroupDuplicate";
123
- output?: {
124
- success?: true;
124
+ type: "DocumentationGroupDuplicate";
125
+ output: {
126
+ success: true;
125
127
  };
126
128
  } | {
127
- type?: "DocumentationGroupDelete";
128
- output?: {
129
- success?: true;
129
+ type: "DocumentationGroupDelete";
130
+ output: {
131
+ success: true;
130
132
  };
131
133
  } | {
132
- type?: "DocumentationTabGroupDelete";
133
- output?: {
134
- success?: true;
134
+ type: "DocumentationTabGroupDelete";
135
+ output: {
136
+ success: true;
135
137
  };
136
138
  } | {
137
- type?: "FigmaNodeRenderAsync";
138
- figmaNodes?: {
139
- id?: string;
140
- designSystemVersionId?: string;
141
- createdAt?: Date;
142
- updatedAt?: Date;
143
- meta?: {
144
- name?: string;
139
+ type: "FigmaNodeRenderAsync";
140
+ figmaNodes: {
141
+ id: string;
142
+ designSystemVersionId: string;
143
+ createdAt: Date;
144
+ updatedAt: Date;
145
+ meta: {
146
+ name: string;
145
147
  description?: string;
146
148
  };
147
- persistentId?: string;
148
- data?: {
149
- sceneNodeId?: string;
150
- format?: "Png" | "Svg";
149
+ persistentId: string;
150
+ data: {
151
+ sceneNodeId: string;
152
+ format: "Png" | "Svg";
153
+ renderState: "Success" | "InProgress" | "Failed";
154
+ hasSource: boolean;
151
155
  scale?: number;
152
- renderState?: "Success" | "InProgress" | "Failed";
153
156
  renderedImage?: {
154
- url?: string;
157
+ resourceId: string;
158
+ format: "Png" | "Svg";
159
+ scale?: number;
155
160
  width?: number;
156
161
  height?: number;
157
- resourceId?: string;
158
- format?: "Png" | "Svg";
159
- scale?: number;
162
+ url?: string;
160
163
  originKey?: string;
161
164
  };
162
165
  renderError?: {
163
- type?: "MissingIntegration" | "NodeNotFound" | "RenderError";
166
+ type: "MissingIntegration" | "NodeNotFound" | "RateLimitExceeded" | "RenderError";
164
167
  };
165
- hasSource?: boolean;
166
168
  };
167
- origin?: {
168
- sourceId?: string;
169
+ origin: {
170
+ sourceId: string;
169
171
  fileId?: string;
170
172
  parentName?: string;
171
173
  };
172
174
  }[];
173
175
  } | {
174
- type?: "DocumentationPageRestore";
175
- output?: {
176
- success?: true;
176
+ type: "DocumentationPageRestore";
177
+ output: {
178
+ success: true;
177
179
  };
178
180
  } | {
179
- type?: "DocumentationGroupRestore";
180
- output?: {
181
- success?: true;
181
+ type: "DocumentationGroupRestore";
182
+ output: {
183
+ success: true;
182
184
  };
183
185
  } | {
184
- type?: "DocumentationPageApprovalStateChange";
185
- output?: {
186
- success?: true;
186
+ type: "DocumentationPageApprovalStateChange";
187
+ output: {
188
+ success: true;
187
189
  };
188
190
  } | {
189
- type?: "ElementPropertyValuesEdit";
190
- output?: {
191
- success?: true;
191
+ type: "ElementPropertyValuesEdit";
192
+ output: {
193
+ success: true;
192
194
  };
193
195
  }>;
194
196
  /** Batch updates, creates or deletes component data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
@@ -47,7 +47,7 @@ export declare class AreaDataSources {
47
47
  isUnpublishedContentFallbackEnabled: boolean;
48
48
  };
49
49
  autoImport: SourceRemoteModelCloud["autoImportMode"];
50
- themeId: string | null;
50
+ themeId?: string | null;
51
51
  }): Promise<Source>;
52
52
  updateFigmaSource(from: RemoteVersionIdentifier, sourceId: string, options: {
53
53
  scopes?: {
@@ -69,18 +69,18 @@ export declare class AreaDesignSystems {
69
69
  createDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>): Promise<DesignSystem>;
70
70
  getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
71
71
  getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
72
- linkPreview?: {
73
- description?: string;
72
+ linkPreview: {
74
73
  title?: string;
74
+ description?: string;
75
75
  thumbnail?: {
76
- type?: "Resource" | "FigmaNode";
76
+ type: "Resource" | "FigmaNode";
77
77
  resource?: {
78
- url?: string;
79
- resourceId?: string;
78
+ resourceId: string;
79
+ url: string;
80
80
  };
81
81
  figmaNode?: {
82
- sourceId?: string;
83
- frameReferenceId?: string;
82
+ sourceId: string;
83
+ frameReferenceId: string;
84
84
  };
85
85
  };
86
86
  };
@@ -174,12 +174,12 @@ export declare class AreaDesignSystems {
174
174
  */
175
175
  startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
176
176
  getPageRedirects(designSystemId: string): Promise<{
177
- id?: string;
178
- path?: string;
179
- createdAt?: Date;
180
- updatedAt?: Date;
181
- designSystemId?: string;
182
- pagePersistentId?: string;
177
+ id: string;
178
+ pagePersistentId: string;
179
+ path: string;
180
+ createdAt: Date;
181
+ updatedAt: Date;
182
+ designSystemId: string;
183
183
  }[]>;
184
184
  createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
185
185
  updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;