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

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 (52) 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/areas/SDKAreaAgentChats.d.ts +4 -1
  4. package/build/types/core/areas/SDKAreaBulkOperations.d.ts +3 -3
  5. package/build/types/core/areas/SDKAreaComponents.d.ts +7 -31
  6. package/build/types/core/areas/SDKAreaDataSources.d.ts +5 -0
  7. package/build/types/core/areas/SDKAreaDocumentation.d.ts +18 -20
  8. package/build/types/core/areas/SDKAreaMCP.d.ts +4 -3
  9. package/build/types/core/areas/SDKAreaMe.d.ts +0 -2
  10. package/build/types/core/areas/SDKAreaProjects.d.ts +77 -922
  11. package/build/types/core/areas/SDKAreaRawData.d.ts +78 -917
  12. package/build/types/core/areas/SDKAreaResources.d.ts +4 -2
  13. package/build/types/core/areas/SDKAreaThreads.d.ts +1 -115
  14. package/build/types/core/areas/SDKAreaTokenValues.d.ts +15 -2
  15. package/build/types/core/areas/SDKAreaTokens.d.ts +3 -4
  16. package/build/types/core/areas/SDKAreaVersions.d.ts +3 -3
  17. package/build/types/core/areas/SDKAreaWorkspaces.d.ts +3 -4
  18. package/build/types/core/data/SDKDataBridge.d.ts +0 -1
  19. package/build/types/core/data/SDKDataCore.d.ts +139 -1091
  20. package/build/types/core/data/SDKDataCoreCached.d.ts +0 -3
  21. package/build/types/core/data/requests/SDKDataCoreReadRequests.d.ts +55 -470
  22. package/build/types/core/data/requests/SDKDataCoreWriteRequests.d.ts +158 -1006
  23. package/build/types/core/resolvers/SDKDocsEntityItemResolver.d.ts +6 -6
  24. package/build/types/exports.d.ts +2 -1
  25. package/build/types/model/activity-events/SDKActivityEvent.d.ts +6710 -3
  26. package/build/types/model/agent-chats/SDKAgentChat.d.ts +12 -1
  27. package/build/types/model/base/SDKDesignSystemVersionStats.d.ts +6 -1
  28. package/build/types/model/docs/blocks/support/SDKDocsImageRef.d.ts +1 -1
  29. package/build/types/model/documentation/SDKPublishedDocsSite.d.ts +20 -0
  30. package/build/types/model/enums/SDKUnit.d.ts +2 -0
  31. package/build/types/model/exporters/exporter_builds/SDKExportDestinations.d.ts +3 -0
  32. package/build/types/model/support/SDKSource.d.ts +1 -1
  33. package/build/types/model/tokens/SDKColorToken.d.ts +4 -0
  34. package/build/types/model/tokens/SDKDimensionToken.d.ts +6 -1
  35. package/build/types/model/users/SDKUserWorkspaceNotificationSettings.d.ts +4 -0
  36. package/build/types/model/workspaces/SDKWorkspaceProduct.d.ts +0 -4
  37. package/build/types/model/workspaces/SDKWorkspaceProductPrice.d.ts +18 -9
  38. package/build/types/model/workspaces/SDKWorkspaceSubscription.d.ts +18 -19
  39. package/build/types/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +3 -6
  40. package/build/types/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +3 -29
  41. package/build/types/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +0 -2
  42. package/build/types/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +0 -31
  43. package/build/types/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +0 -2
  44. package/build/types/tools/token-preview/TokenUtilPreviewTypes.d.ts +2 -0
  45. package/build/types/utils/TokenUtils.d.ts +12 -4
  46. package/package.json +5 -23
  47. package/build/types/tools/design-tokens/utilities/unresolvable-modes/index.d.ts +0 -4
  48. package/build/types/tools/design-tokens/utilities/unresolvable-modes/lenient-resolve.d.ts +0 -2
  49. package/build/types/tools/design-tokens/utilities/unresolvable-modes/placeholder.d.ts +0 -2
  50. package/build/types/tools/design-tokens/utilities/unresolvable-modes/preserve.d.ts +0 -2
  51. package/build/types/tools/design-tokens/utilities/unresolvable-modes/strict.d.ts +0 -2
  52. package/build/types/tools/design-tokens/utilities/unresolvable-modes/types.d.ts +0 -33
@@ -1,4 +1,4 @@
1
- import type { AgentChat, AgentChatChangedEntity, AgentChatCreateInput, AgentChatDeleteResponse, AgentChatListFilter, AgentChatUpdateInput } from "../../model/agent-chats/SDKAgentChat";
1
+ import type { AgentChat, AgentChatChangedEntity, AgentChatCreateInput, AgentChatDeleteResponse, AgentChatListFilter, AgentChatUpdateInput, AgentTurnRating, AgentTurnRatingInput } from "../../model/agent-chats/SDKAgentChat";
2
2
  import { DataCore } from "../data/SDKDataCore";
3
3
  export declare class AreaAgentChats {
4
4
  private dataCore;
@@ -6,6 +6,9 @@ export declare class AreaAgentChats {
6
6
  list(filter: AgentChatListFilter): Promise<AgentChat[]>;
7
7
  getByEveSession(eveSessionId: string): Promise<AgentChat>;
8
8
  listChangedEntities(chatId: string): Promise<AgentChatChangedEntity[]>;
9
+ listTurnRatings(chatId: string): Promise<AgentTurnRating[]>;
10
+ /** Stores the rating for one assistant turn, replacing an earlier one */
11
+ rateTurn(chatId: string, turnId: string, input: AgentTurnRatingInput): Promise<AgentTurnRating>;
9
12
  create(input: AgentChatCreateInput): Promise<AgentChat>;
10
13
  update(chatId: string, input: AgentChatUpdateInput): Promise<AgentChat>;
11
14
  delete(chatId: string): Promise<AgentChatDeleteResponse>;
@@ -139,18 +139,18 @@ export declare class AreaBulkOperations {
139
139
  type: "FigmaNodeRenderAsync";
140
140
  figmaNodes: {
141
141
  id: string;
142
- designSystemVersionId: string;
143
142
  createdAt: Date;
143
+ designSystemVersionId: string;
144
+ persistentId: string;
144
145
  updatedAt: Date;
145
146
  meta: {
146
147
  name: string;
147
148
  description?: string;
148
149
  };
149
- persistentId: string;
150
150
  data: {
151
151
  sceneNodeId: string;
152
152
  format: "Png" | "Svg";
153
- renderState: "Success" | "InProgress" | "Failed";
153
+ renderState: "InProgress" | "Success" | "Failed";
154
154
  hasSource: boolean;
155
155
  scale?: number;
156
156
  renderedImage?: {
@@ -19,6 +19,12 @@ export declare class AreaComponents {
19
19
  getComponents(from: RemoteVersionIdentifier, filter?: {
20
20
  brandId?: string;
21
21
  }): Promise<Array<Component>>;
22
+ /** Fetches a remote component in the version
23
+ * @param from - Remote version to fetch from
24
+ * @param componentIdInVersion - Component idInVersion to fetch
25
+ * @returns The component with its resolved properties and values
26
+ */
27
+ getComponent(from: RemoteVersionIdentifier, componentIdInVersion: string): Promise<Component>;
22
28
  /** Fetches all remote component groups in the version
23
29
  * @param from - Remote version to fetch from
24
30
  * @returns All component groups in the specified version
@@ -68,17 +74,7 @@ export declare class AreaComponents {
68
74
  * @returns New component filled with default values not associated with remote (yet)
69
75
  */
70
76
  createLocalComponent(versionId: string, brandId: string): Component;
71
- /** Creates remote component group. This method can only be used once per group and will assign persistent id to the group. Calling this version on group that already has id assigned will result in error
72
- * @param to - Remote version to write to
73
- * @param group - Group to create
74
- * @param parentId - Id of the group to add the group to. This is id of the group, not the versioned id
75
- * @returns New remote component group ids
76
- */
77
- createComponentGroup(to: RemoteVersionIdentifier, group: ComponentGroup): Promise<{
78
- id: string;
79
- idInVersion: string;
80
- }>;
81
- /** Creates local component group. This group doesn't have id associated with it on remote, and must be created once with `createComponentGroup` to be stored in design system
77
+ /** Creates a local component group without persisting it to the remote design system
82
78
  * @param versionId - Id of the version to create the group in
83
79
  * @param brandId - Id of the brand to create the group in
84
80
  * @returns New group with id assigned
@@ -90,12 +86,6 @@ export declare class AreaComponents {
90
86
  * @returns Nothing
91
87
  */
92
88
  updateComponent(to: RemoteVersionIdentifier, component: Component): Promise<void>;
93
- /** Updates remote component groups. This method can only be used on component groups that already exist in the version
94
- * @param to - Remote version to write to
95
- * @param component - Component group to update
96
- * @returns Nothing
97
- */
98
- updateComponentGroup(to: RemoteVersionIdentifier, group: ComponentGroup): Promise<void>;
99
89
  /** Updates remote component property value. This also creates the property value if it doesn't exist
100
90
  * @param to - Remote version to write to
101
91
  * @param newValue - Value to set - this can be multiple things, from ID to raw string value to others
@@ -145,18 +135,4 @@ export declare class AreaComponents {
145
135
  * @returns Nothing
146
136
  */
147
137
  deleteComponent(to: RemoteVersionIdentifier, componentIdInVersion: string): Promise<void>;
148
- /** Deletes remote component group. This method will also fix the component group tree by moving any subgroups to parent - do note it will NOT delete contents of the group. Calling this method on group that doesn't exist in the version will result in error
149
- * @param to - Remote version to write to
150
- * @param componentGroupIdInVersion - Component group idInVersion to delete
151
- * @returns Nothing
152
- */
153
- ungroupComponentGroup(to: RemoteVersionIdentifier, componentGroupIdInVersion: string): Promise<void>;
154
- /** Deletes remote component group and all its descendants. All items (groups and components) underneath will be deleted. Calling this method on group that doesn't exist in the version will result in error
155
- * @param to - Remote version to write to
156
- * @param componentGroupToDelete - Component group to delete
157
- * @param allComponents - Components for lookup
158
- * @param allComponentGroup - Component group for lookup
159
- * @returns Nothing
160
- */
161
- deleteComponentGroup(to: RemoteVersionIdentifier, componentGroupToDelete: ComponentGroup, components: Array<Component>, componentGroups: Array<ComponentGroup>): Promise<void>;
162
138
  }
@@ -25,6 +25,11 @@ export declare class AreaDataSources {
25
25
  getDataSources(from: {
26
26
  designSystemId: string;
27
27
  }): Promise<Array<Source>>;
28
+ /** Retrieves how many Figma sources count against the plan limit
29
+ * @param workspaceId - Workspace to count across; the limit applies to all its design systems
30
+ * @returns Number of Figma sources in the workspace
31
+ */
32
+ getWorkspaceFigmaSourceCount(workspaceId: string): Promise<number>;
28
33
  /** Retrieves all figma frames structures
29
34
  * @param from - Remote version to fetch from
30
35
  * @returns All data sources in the specified version
@@ -9,6 +9,7 @@ import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
9
9
  import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
10
10
  import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
11
11
  import { PageHistoryVersion, PageHistoryVersionContent } from "../../model/documentation/SDKPageHistoryVersion";
12
+ import { PublishedDocsSite } from "../../model/documentation/SDKPublishedDocsSite";
12
13
  import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
13
14
  import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
14
15
  import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -51,6 +52,8 @@ export declare class AreaDocumentation {
51
52
  * @returns documentation url string
52
53
  */
53
54
  getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string | null>;
55
+ /** Fetches published documentation site metadata for the version. */
56
+ getPublishedDocsSites(from: RemoteVersionIdentifier): Promise<PublishedDocsSite[]>;
54
57
  /** Retrieve information for an ongoing publishing build if any exists. */
55
58
  isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
56
59
  status: DocsPublishStatus.inProgress;
@@ -175,18 +178,18 @@ export declare class AreaDocumentation {
175
178
  type: "FigmaNodeRenderAsync";
176
179
  figmaNodes: {
177
180
  id: string;
178
- designSystemVersionId: string;
179
181
  createdAt: Date;
182
+ designSystemVersionId: string;
183
+ persistentId: string;
180
184
  updatedAt: Date;
181
185
  meta: {
182
186
  name: string;
183
187
  description?: string;
184
188
  };
185
- persistentId: string;
186
189
  data: {
187
190
  sceneNodeId: string;
188
191
  format: "Png" | "Svg";
189
- renderState: "Success" | "InProgress" | "Failed";
192
+ renderState: "InProgress" | "Success" | "Failed";
190
193
  hasSource: boolean;
191
194
  scale?: number;
192
195
  renderedImage?: {
@@ -303,18 +306,18 @@ export declare class AreaDocumentation {
303
306
  type: "FigmaNodeRenderAsync";
304
307
  figmaNodes: {
305
308
  id: string;
306
- designSystemVersionId: string;
307
309
  createdAt: Date;
310
+ designSystemVersionId: string;
311
+ persistentId: string;
308
312
  updatedAt: Date;
309
313
  meta: {
310
314
  name: string;
311
315
  description?: string;
312
316
  };
313
- persistentId: string;
314
317
  data: {
315
318
  sceneNodeId: string;
316
319
  format: "Png" | "Svg";
317
- renderState: "Success" | "InProgress" | "Failed";
320
+ renderState: "InProgress" | "Success" | "Failed";
318
321
  hasSource: boolean;
319
322
  scale?: number;
320
323
  renderedImage?: {
@@ -431,18 +434,18 @@ export declare class AreaDocumentation {
431
434
  type: "FigmaNodeRenderAsync";
432
435
  figmaNodes: {
433
436
  id: string;
434
- designSystemVersionId: string;
435
437
  createdAt: Date;
438
+ designSystemVersionId: string;
439
+ persistentId: string;
436
440
  updatedAt: Date;
437
441
  meta: {
438
442
  name: string;
439
443
  description?: string;
440
444
  };
441
- persistentId: string;
442
445
  data: {
443
446
  sceneNodeId: string;
444
447
  format: "Png" | "Svg";
445
- renderState: "Success" | "InProgress" | "Failed";
448
+ renderState: "InProgress" | "Success" | "Failed";
446
449
  hasSource: boolean;
447
450
  scale?: number;
448
451
  renderedImage?: {
@@ -598,18 +601,18 @@ export declare class AreaDocumentation {
598
601
  type: "FigmaNodeRenderAsync";
599
602
  figmaNodes: {
600
603
  id: string;
601
- designSystemVersionId: string;
602
604
  createdAt: Date;
605
+ designSystemVersionId: string;
606
+ persistentId: string;
603
607
  updatedAt: Date;
604
608
  meta: {
605
609
  name: string;
606
610
  description?: string;
607
611
  };
608
- persistentId: string;
609
612
  data: {
610
613
  sceneNodeId: string;
611
614
  format: "Png" | "Svg";
612
- renderState: "Success" | "InProgress" | "Failed";
615
+ renderState: "InProgress" | "Success" | "Failed";
613
616
  hasSource: boolean;
614
617
  scale?: number;
615
618
  renderedImage?: {
@@ -706,15 +709,10 @@ export declare class AreaDocumentation {
706
709
  * @param to - Remote version where the build should be created
707
710
  * @param environment - Environment to publish to
708
711
  * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
712
+ * @param changes - Specific page/group ids to publish. Omit to publish everything.
709
713
  * */
710
- publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
711
- /** Publish documentation drafts. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
712
- * You can request status of the build with associated `isPublishing` method. New endpoint supports publishing drafts.
713
- * @param to - Remote version where the build should be created
714
- * @param environment - Environment to publish to
715
- * @param changes - Specific page/group ids that needs to be published
716
- * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
717
- * */
714
+ publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean, changes?: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuild>;
715
+ /** @deprecated Use `publish(to, environment, isForcing, changes)` */
718
716
  publishDrafts(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"], isForcing?: boolean): Promise<ExportBuild>;
719
717
  getDocumentationPageAnchors(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
720
718
  getDocumentationDependencies(from: RemoteVersionIdentifier): Promise<DTODocumentationPageDependenciesGetResponse["dependencies"]>;
@@ -34,12 +34,13 @@ export declare class AreaMCP {
34
34
  */
35
35
  getConsumerCount(workspaceId: string, contextId?: string, designSystemId?: string): Promise<number>;
36
36
  /**
37
- * Retrieves MCP analytics for a design system and date range.
38
- * @param designSystemId - The ID of the design system.
37
+ * Retrieves MCP analytics for a date range, optionally scoped to a design system.
38
+ * @param workspaceId - The ID of the workspace to scope analytics to.
39
+ * @param designSystemId - The ID of the design system, or null for unscoped analytics.
39
40
  * @param filters - The connection and date filters.
40
41
  * @returns The MCP analytics data.
41
42
  */
42
- getAnalytics(designSystemId: string, filters: Pick<DTOMCPAnalyticsFiltersQuery, "connectionType" | "contextIds" | "start" | "end">): Promise<DTOMCPAnalyticsResponse>;
43
+ getAnalytics(workspaceId: string, designSystemId: string | null, filters: Pick<DTOMCPAnalyticsFiltersQuery, "connectionType" | "contextIds" | "start" | "end">): Promise<DTOMCPAnalyticsResponse>;
43
44
  /**
44
45
  * Updates the user's MCP stream with the provided data.
45
46
  * @param data - The update input containing optional projectFeatureId and projectDocumentId.
@@ -17,8 +17,6 @@ export declare class AreaMe {
17
17
  updateAvatar(userId: string, avatar: File): Promise<void>;
18
18
  /** Deletes the current user user based on the API key provided to Supernova instance. Also removes all owned workspaces and updates memberships where user belongs. */
19
19
  deleteMe(userId: string): Promise<void>;
20
- /** Checks whether user can be deleted. There are certain restrictions, like users who don't have all bills settled in their associated workspaces can't be deleted, for example */
21
- canDeleteMe(userId: string): Promise<boolean>;
22
20
  /** Updates the avatar of the current user */
23
21
  deleteAvatar(userId: string): Promise<void>;
24
22
  }