@supernova-studio/supernova-sdk-beta 1.6.33 → 1.6.34

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 (82) hide show
  1. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +0 -4
  2. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +14 -1
  3. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +1 -34
  4. package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +2 -6
  5. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +1 -4
  6. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +19 -18
  7. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +7 -7
  8. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +8 -9
  9. package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +0 -4
  10. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +1 -1
  11. package/build/sdk-typescript/src/exports.d.ts +1 -9
  12. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +11 -2
  13. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +21 -5
  14. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +10 -3
  15. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +7 -2
  16. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +15 -2
  17. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +1 -1
  18. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
  19. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +2 -2
  20. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -2
  21. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +1 -1
  22. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +10 -2
  23. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -3
  24. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
  25. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +1 -10
  26. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +2 -23
  27. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +1 -1
  28. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +2 -2
  29. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +2 -5
  30. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +7 -10
  31. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +20 -7
  32. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +7 -2
  33. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +0 -3
  34. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
  35. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
  36. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +1 -5
  37. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
  38. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
  39. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
  40. package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +4 -0
  41. package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
  42. package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
  43. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +0 -6
  44. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +0 -12
  45. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +1 -16
  46. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
  47. package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +0 -4
  48. package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +2 -2
  49. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +0 -2
  50. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +4 -10
  51. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
  52. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +6 -6
  53. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +6 -6
  54. package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +0 -1
  55. package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
  56. package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
  57. package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
  58. package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
  59. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +2 -2
  60. package/build/sdk-typescript/src/tests/Enterprise/PluginFigmaTokens.spec.d.ts +1 -0
  61. package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
  62. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +1 -2
  63. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
  64. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
  65. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +0 -11
  66. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
  67. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
  68. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +1 -4
  69. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +1 -4
  70. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +3 -3
  71. package/build/supernova-sdk-typescript.js +1 -1
  72. package/build/supernova-sdk-typescript.js.LICENSE.txt +14 -0
  73. package/build/supernova-sdk-typescript.js.map +1 -1
  74. package/package.json +118 -122
  75. package/build/sdk-typescript/.eslintrc.d.cts +0 -41
  76. package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +0 -10
  77. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +0 -13
  78. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +0 -19
  79. package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +0 -8
  80. package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +0 -4
  81. package/build/sdk-typescript/src/utils/CommonUtils.d.ts +0 -5
  82. package/build/sdk-typescript/src/utils/deepPartial.d.ts +0 -3
@@ -8,7 +8,6 @@ import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
8
8
  import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
9
9
  import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
10
10
  import { AreaMe } from "./areas/SDKAreaMe";
11
- import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
12
11
  import { AreaNetwork } from "./areas/SDKAreaNetwork";
13
12
  import { AreaResources } from "./areas/SDKAreaResources";
14
13
  import { AreaStorage } from "./areas/SDKAreaStorage";
@@ -58,8 +57,6 @@ export declare class Supernova {
58
57
  storage: AreaStorage;
59
58
  /** Get access to network in exporter packages */
60
59
  network: AreaNetwork;
61
- /** Get access to multiplayer capabilities */
62
- multiplayer: AreaMultiplayer;
63
60
  /**
64
61
  * Create new Supernova.io SDK object.
65
62
  * @param apiKey API key to use for authentication
@@ -72,6 +69,5 @@ export declare class Supernova {
72
69
  apiUrl?: string;
73
70
  requestHook?: DataBridgeRequestHook;
74
71
  bypassEnvFetch?: boolean;
75
- proxyUrl?: string;
76
72
  });
77
73
  }
@@ -1,3 +1,4 @@
1
+ import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
1
2
  import { CodegenAccount } from "../../model/exporters/CodegenAccount";
2
3
  import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
3
4
  import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
@@ -20,7 +21,7 @@ import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuil
20
21
  import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
21
22
  import { ImportJob } from "../../model/jobs/SDKImportJob";
22
23
  import { DataCore } from "../data/SDKDataCore";
23
- import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
24
+ import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
24
25
  export declare class AreaAutomation {
25
26
  /** Internal: Engine */
26
27
  private dataCore;
@@ -184,6 +185,18 @@ export declare class AreaAutomation {
184
185
  * @returns All custom variants
185
186
  */
186
187
  getExporterBlockVariants(workspaceId: string, exporterId: string): Promise<Array<ExporterCustomBlockVariant>>;
188
+ /** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline. You can request status of the build with associated `isBeingPublished` method. */
189
+ publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
190
+ status: "Queued" | "InProgress" | "Failure";
191
+ jobId: string | null;
192
+ exporterId: string | null;
193
+ }>;
194
+ /** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline. You can request status of the build with associated `isBeingPublished` method. */
195
+ isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
196
+ status: "InProgress" | "Idle";
197
+ jobId: string | null;
198
+ exporterId: string | null;
199
+ }>;
187
200
  /** Gets all import jobs that are currently in progress.
188
201
  * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
189
202
  * @returns Nothing
@@ -5,11 +5,7 @@ import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
5
5
  import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
6
6
  import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
7
7
  import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
8
- import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
9
- import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
10
- import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
11
- import { DeepPartial } from "../../utils/deepPartial";
12
- import { DataCore } from "../data/SDKDataCore";
8
+ import { DataCore, DeepPartial } from "../data/SDKDataCore";
13
9
  import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
14
10
  export declare class AreaDocumentation {
15
11
  /** Internal: Engine */
@@ -25,28 +21,6 @@ export declare class AreaDocumentation {
25
21
  * @returns documentation url string
26
22
  */
27
23
  getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string>;
28
- /** Retrieve information for an ongoing publishing build if any exists. */
29
- isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
30
- status: DocsPublishStatus.inProgress;
31
- job: ExportBuild;
32
- } | {
33
- status: DocsPublishStatus.idle;
34
- job: null;
35
- }>;
36
- /** Fetches a documentation build.
37
- * @param workspaceId - Identifier of the workspace associated with the build.
38
- * @param buildId - Identifier of the build.
39
- */
40
- getDocumentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
41
- /** Fetches documentation builds filtered according to the params.
42
- * @param workspaceId - Identifier of the workspace associated with the builds.
43
- * @param versionId - Identifier of the design system version associated with the builds.
44
- * @param environment - Environment of the builds.
45
- * @param status - Status of the builds.
46
- * @param createdByUserId - Identifier of the user who created the builds.
47
- * @param limit - Number of builds to return.
48
- */
49
- getDocumentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
50
24
  /** Updates documentation structure
51
25
  * @param from - Remote version to fetch from
52
26
  * @param model - documentation legacy model
@@ -158,13 +132,6 @@ export declare class AreaDocumentation {
158
132
  * @returns Room ID that can be immediately used to join the multiplayer room
159
133
  */
160
134
  getDocumentationPageRoomId(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<string>;
161
- /** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
162
- * You can request status of the build with associated `isPublishing` method.
163
- * @param to - Remote version where the build should be created
164
- * @param environment - Environment to publish to
165
- * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
166
- * */
167
- publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
168
135
  getDocumentationMockedStructure(): Array<DocsEntity>;
169
136
  getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
170
137
  getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
@@ -18,11 +18,7 @@ export declare class AreaResources {
18
18
  /** Uploads new asset resource */
19
19
  uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
20
20
  /** Uploads new font resource */
21
- uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont | null>;
22
- /** Uploads new font resources */
23
- uploadFontResources(from: RemoteVersionIdentifier, fonts: FileList): Promise<ResourceFont[]>;
24
- /** Deletes single resource of any type */
21
+ uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont>;
22
+ /** Deletes resource of any type */
25
23
  deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
26
- /** Deletes multiple resource of any type */
27
- deleteResources(from: RemoteVersionIdentifier, resourceIds: string[]): Promise<void>;
28
24
  }
@@ -1,4 +1,3 @@
1
- import { HttpsProxyAgent } from "https-proxy-agent";
2
1
  type DataBridgeRequestHookResult = {
3
2
  skipDefaultAuth?: boolean;
4
3
  };
@@ -22,7 +21,6 @@ export type DataBridgeConfiguration = {
22
21
  requestHook: DataBridgeRequestHook | null;
23
22
  debugRequestObserver?: DebugRequestObserver | null;
24
23
  debugResponseObserver?: DebugResponseObserver | null;
25
- proxyUrl?: string | null;
26
24
  };
27
25
  export declare class DataBridge {
28
26
  authToken: string;
@@ -30,7 +28,6 @@ export declare class DataBridge {
30
28
  apiVersion: string;
31
29
  target: string | null;
32
30
  bypassEnvFetch: boolean;
33
- proxyAgent: HttpsProxyAgent<string> | undefined;
34
31
  requestHook: DataBridgeRequestHook | null;
35
32
  debugRequestObserver: DebugRequestObserver | null;
36
33
  debugResponseObserver: DebugResponseObserver | null;
@@ -39,7 +36,7 @@ export declare class DataBridge {
39
36
  get(endpoint: string): Promise<any>;
40
37
  put(endpoint: string, payload: any | null): Promise<any>;
41
38
  post(endpoint: string, payload: any | null): Promise<any>;
42
- upload(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<any>;
39
+ upload(endpoint: string, fileKey: string, file: File, method?: "PUT" | "POST"): Promise<any>;
43
40
  private request;
44
41
  private handleResponse;
45
42
  private buildRequestConfig;
@@ -1,4 +1,4 @@
1
- import { ExportBuildStatus, ResourceFont } from "../../exports";
1
+ import { ResourceFont } from "../../exports";
2
2
  import { Acl } from "../../model/acl/SDKAcl";
3
3
  import { Asset } from "../../model/assets/SDKAsset";
4
4
  import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
@@ -70,11 +70,13 @@ import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspace
70
70
  import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
71
71
  import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
72
72
  import { WorkspaceSubscription, WorkspaceSubscriptionUpdateModel } from "../../model/workspaces/SDKWorkspaceSubscription";
73
- import { DeepPartial } from "../../utils/deepPartial";
74
73
  import { ComponentUpdateTransactionData, TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
75
74
  import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
76
75
  import { DataBridge } from "./SDKDataBridge";
77
76
  import { RequestInfo, RequestInit, Response } from "node-fetch";
77
+ export type DeepPartial<T> = T extends object ? {
78
+ [P in keyof T]?: DeepPartial<T[P]>;
79
+ } : T;
78
80
  export declare class DataCore {
79
81
  /** Read part of the network calls */
80
82
  private read;
@@ -86,10 +88,6 @@ export declare class DataCore {
86
88
  private bridge;
87
89
  constructor(bridge: DataBridge);
88
90
  fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
89
- /** Remote: Get single-use multiplayer token */
90
- multiplayerToken(room: string): Promise<{
91
- token: string;
92
- }>;
93
91
  /** Remote: Get information about currently logged in user */
94
92
  currentUser(): Promise<User>;
95
93
  /** Remote: Get information about a specific user */
@@ -268,7 +266,11 @@ export declare class DataCore {
268
266
  /** Retrieve currently deployed documentation url */
269
267
  documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
270
268
  /** Publish the documentation */
271
- documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
269
+ documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<{
270
+ status: "Queued" | "InProgress" | "Failure";
271
+ jobId: string;
272
+ exporterId: string;
273
+ }>;
272
274
  /** Retrieve all asset resources */
273
275
  assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
274
276
  /** Retrieve all font resources */
@@ -276,13 +278,9 @@ export declare class DataCore {
276
278
  /** Upload asset resource */
277
279
  uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAsset>;
278
280
  /** Upload font resource */
279
- uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont | null>;
280
- /** Upload font resources */
281
- uploadFontResources(designSystemId: string, versionId: string, fonts: FileList): Promise<ResourceFont[]>;
282
- /** Delete any single resource */
281
+ uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont>;
282
+ /** Delete any resource */
283
283
  deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
284
- /** Delete any multiple resources */
285
- deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
286
284
  pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
287
285
  githubConnections(): Promise<Array<CodegenConnection>>;
288
286
  githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;
@@ -331,10 +329,13 @@ export declare class DataCore {
331
329
  deleteExporter(workspaceId: string, exporterId: string): Promise<void>;
332
330
  /** Pull updates for exporter */
333
331
  pullLatestExporter(workspaceId: string, exporterId: string): Promise<Exporter>;
334
- exportBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuild>>;
335
- documentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
332
+ exportBuilds(workspaceId: string, exporterId: string, limit?: number): Promise<Array<ExportBuild>>;
336
333
  /** Download information about documentation builds and retrieve it resolved */
337
- documentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
334
+ documentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
335
+ status: "InProgress" | "Success" | "Failed";
336
+ id: string | null;
337
+ exporterId: string | null;
338
+ }>>;
338
339
  buildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLog>>;
339
340
  workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
340
341
  /** Download information about a single workspace and retrieve it resolved */
@@ -376,8 +377,8 @@ export declare class DataCore {
376
377
  deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
377
378
  deleteWorkspaceMember(workspaceId: string, userId: string): Promise<void>;
378
379
  deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
379
- createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
380
- createPortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
380
+ createCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity: number | null): Promise<string>;
381
+ createPortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null, cancel: boolean | null): Promise<string>;
381
382
  resendWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
382
383
  restoreWorkspaceSubscription(workspaceId: string): Promise<void>;
383
384
  /** Download information about a single design system and retrieve it resolved */
@@ -15,7 +15,7 @@ import { TokenType } from "../../../model/enums/SDKTokenType";
15
15
  import { CodegenBitbucketProject } from "../../../model/exporters/CodegenBitbucketProject";
16
16
  import { ExporterModel, ExporterProvider } from "../../../model/exporters/SDKExporter";
17
17
  import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
18
- import { ExportBuildModel, ExportBuildStatus } from "../../../model/exporters/exporter_builds/SDKExportBuild";
18
+ import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
19
19
  import { ExportBuildResultLogModel } from "../../../model/exporters/exporter_builds/SDKExportBuildResults";
20
20
  import { CodegenAzureBranchRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenBranchModel";
21
21
  import { CodegenAzureOrganizationRemoteModel } from "../../../model/exporters/remote/SDKRemoteAzureCodegenOrganizationModel";
@@ -62,10 +62,6 @@ export declare class DataCoreReadRequests {
62
62
  private bridge;
63
63
  constructor(bridge: DataBridge);
64
64
  /** Remote: Get information about currently logged in user */
65
- getRemoteMultiplayerToken(room: string): Promise<{
66
- token: string;
67
- }>;
68
- /** Remote: Get information about currently logged in user */
69
65
  getRemoteCurrentUser(): Promise<UserRemoteModel>;
70
66
  /** Remote: Get information about a specific user */
71
67
  getRemoteUser(userId: any): Promise<UserRemoteModel>;
@@ -184,8 +180,12 @@ export declare class DataCoreReadRequests {
184
180
  getRemoteBitbucketProjects(connectionId: string, worksapceId: string): Promise<CodegenBitbucketProject[]>;
185
181
  getRemoteBitbucketRepositories(connectionId: string, workspaceId: string, projectKey?: string): Promise<CodegenBitbucketRepositoryRemoteModel[]>;
186
182
  getRemoteBitbucketBranches(connectionId: string, workspaceId: string, projectId: string, repositoryId: string): Promise<CodegenBitbucketBranchRemoteModel[]>;
187
- getRemoteBuild(workspaceId: string, buildId: string): Promise<ExportBuildModel>;
188
- getRemoteBuilds(workspaceId: string, versionId: string, docsEnvironment?: DocumentationEnvironment, limit?: number, offset?: number, scheduleId?: string, exporterId?: string, destinations?: Array<"s3" | "webhook" | "github" | "documentation" | "azure" | "gitlab">, createdByUserId?: string, status?: ExportBuildStatus): Promise<Array<ExportBuildModel>>;
183
+ getRemoteBuilds(workspaceId: string, versionId: string): Promise<Array<ExportBuildModel>>;
184
+ getRemoteDocumentationBuilds(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment, limit?: number): Promise<Array<{
185
+ status: "InProgress" | "Success" | "Failed";
186
+ id: string | null;
187
+ exporterId: string | null;
188
+ }>>;
189
189
  getRemoteBuildLogs(workspaceId: string, buildId: string): Promise<Array<ExportBuildResultLogModel>>;
190
190
  getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
191
191
  getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
@@ -11,9 +11,7 @@ import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders
11
11
  import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
12
12
  import { UserRoleWithoutOwner } from "../../../model/enums/SDKUserRole";
13
13
  import { AzurePersonalAccessTokenConnectionPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
14
- import { ExporterProvider, NewExporterPayload } from "../../../model/exporters/SDKExporter";
15
14
  import { NewPipelinePayload, PipelineUpdateModel } from "../../../model/exporters/SDKPipeline";
16
- import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
17
15
  import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
18
16
  import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
19
17
  import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
@@ -35,6 +33,7 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
35
33
  import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
36
34
  import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
37
35
  import { DataBridge } from "../SDKDataBridge";
36
+ import { ExporterProvider, NewExporterPayload } from "model/exporters/SDKExporter";
38
37
  export declare class DataCoreWriteRequests {
39
38
  private bridge;
40
39
  constructor(bridge: DataBridge);
@@ -104,7 +103,7 @@ export declare class DataCoreWriteRequests {
104
103
  /** Remote: create Checkout session */
105
104
  createRemoteCheckoutSession(workspaceId: string, priceId: string, successUrl: string, cancelUrl: string, quantity?: number | null): Promise<string>;
106
105
  /** Remote: create Customer portal session */
107
- createRemotePortalSession(workspaceId: string, returnUrl: string, update?: WorkspaceSubscriptionUpdateModel | null, cancel?: boolean | null): Promise<string>;
106
+ createRemotePortalSession(workspaceId: string, returnUrl: string, update: WorkspaceSubscriptionUpdateModel | null, cancel: boolean | null): Promise<string>;
108
107
  /** Remote: Resend the invitation */
109
108
  resendRemoteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
110
109
  /** Remote: Restore the cancelled subscription */
@@ -173,7 +172,11 @@ export declare class DataCoreWriteRequests {
173
172
  deleteRemoteDocumentationGroup(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
174
173
  /** Remote: Deletes a documentation group and its contents */
175
174
  deleteRemoteDocumentationGroupAndTree(designSystemId: string, versionId: string, group: DocumentationLegacyGroup): Promise<void>;
176
- publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
175
+ publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<{
176
+ status: "Queued" | "InProgress" | "Failure";
177
+ jobId: string;
178
+ exporterId: string;
179
+ }>;
177
180
  createRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
178
181
  updateRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
179
182
  createRemoteTokenGroup(designSystemId: string, versionId: string, group: TokenGroupRemoteModel): Promise<TokenGroupRemoteModel>;
@@ -195,13 +198,9 @@ export declare class DataCoreWriteRequests {
195
198
  /** Remote: Upload a new asset resource */
196
199
  uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAssetModel>;
197
200
  /** Remote: Upload a new font resource */
198
- uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel | null>;
199
- /** Remote: Upload a new font resources */
200
- uploadFontResources(designSystemId: string, versionId: string, fonts: FileList): Promise<ResourceFontModel[]>;
201
+ uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel>;
201
202
  /** Remote: Delete a resource */
202
203
  deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
203
- /** Remote: Delete resources */
204
- deleteResources(designSystemId: string, versionId: string, resourceIds: string[]): Promise<void>;
205
204
  createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
206
205
  updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
207
206
  createRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<ComponentGroupRemoteModel>;
@@ -5,10 +5,6 @@ export declare class AssetGroupResolver {
5
5
  assets: Array<Asset>;
6
6
  constructor(assets: Array<Asset>);
7
7
  resolveGroupData(data: Array<DesignComponentGroupRemoteModel>): Array<AssetGroup>;
8
- private markAssetGroups;
9
- private markAssetAncestors;
10
- private assignSourceDataToGroups;
11
- private propagateSourceDataToAncestors;
12
8
  private recomputePaths;
13
9
  private recomputePathsFromRoot;
14
10
  private reorderGroupsByRoots;
@@ -40,7 +40,7 @@ export declare class TokenResolver {
40
40
  fixMultilayerGradientTokens(tokens: Array<GradientToken>, groups: Array<TokenGroup>): void;
41
41
  fixMultilayerBlurTokens(tokens: Array<BlurToken>, groups: Array<TokenGroup>): void;
42
42
  findAssociatedTokens<T extends Token>(token: T, tokens: Array<T>, groups: Array<TokenGroup>): Array<T>;
43
- actualOriginTokenId(id: string | null): string | null | undefined;
43
+ actualOriginTokenId(id: string | null): string;
44
44
  constructReferencedToken(rawData: TokenRemoteModel, properties: Array<ElementProperty>, values: Array<ElementPropertyValue>): Token;
45
45
  constructReferencedThemedToken(rawData: TokenThemeOverrideRemoteModel, themeId: string): Token;
46
46
  constructResolvedThemedToken(rawData: TokenThemeOverrideRemoteModel, referencedToken: Token, themeId: string): Token;
@@ -32,10 +32,8 @@ export { SubscriptionProductFeatures } from "./model/workspaces/SDKWorkspaceProd
32
32
  export type { ProductFeature } from "./model/workspaces/SDKWorkspaceProductFeatures";
33
33
  export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspaceProductFeatures";
34
34
  export { Brand } from "./model/base/SDKBrand";
35
- export type { BrandUpdateModel } from "./model/base/SDKBrand";
36
35
  export { DesignSystem } from "./model/base/SDKDesignSystem";
37
36
  export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
38
- export type { DesignSystemVersionUpdateModel } from "./model/base/SDKDesignSystemVersion";
39
37
  export { Membership } from "./model/membership/SDKMembership";
40
38
  export { Exporter, type NewExporterPayload, type ExporterProvider, } from "./model/exporters/SDKExporter";
41
39
  export { Pipeline } from "./model/exporters/SDKPipeline";
@@ -93,8 +91,6 @@ export { DocsBlockNumberPropertyDefinition } from "./model/docs/blocks/propertie
93
91
  export type { DocsBlockNumberPropertyData, DocsBlockNumberPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockNumberProperty";
94
92
  export { DocsBlockRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
95
93
  export type { DocsBlockRichTextPropertyData, DocsBlockRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockRichTextProperty";
96
- export { DocsBlockMultiRichTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
97
- export type { DocsBlockMultiRichTextPropertyData, DocsBlockMultiRichTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty";
98
94
  export { DocsBlockSingleSelectPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
99
95
  export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty";
100
96
  export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
@@ -110,8 +106,6 @@ export type { DocsBlockTokenPropertyPropertyData, DocsBlockTokenPropertyProperty
110
106
  export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
111
107
  export type { DocsBlockTokenTypePropertyData, DocsBlockTokenTypePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
112
108
  export { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
113
- export type { DocsBlockColorPropertyData, DocsBlockColorPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockColorProperty";
114
- export { DocsBlockColorPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockColorProperty";
115
109
  export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
116
110
  export { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
117
111
  export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
@@ -205,8 +199,6 @@ export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
205
199
  export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
206
200
  export { SourceType } from "./model/enums/SDKSourceType";
207
201
  export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
208
- export { DocsPublishStatus } from "./model/enums/SDKDocsPublishStatus";
209
- export { DocumentationEnvironment } from "./model/enums/SDKDocumentationEnvironment";
210
202
  export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
211
203
  export { FrameLayout } from "./model/enums/SDKFrameLayout";
212
204
  export { GradientType } from "./model/enums/SDKGradientType";
@@ -257,7 +249,7 @@ export { TextCaseToken } from "./model/tokens/SDKTextCaseToken";
257
249
  export { TextDecorationToken } from "./model/tokens/SDKTextDecorationToken";
258
250
  export { VisibilityToken } from "./model/tokens/SDKVisibilityToken";
259
251
  export { Token } from "./model/tokens/SDKToken";
260
- export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTokenValue, GradientStopValue, GradientTokenValue, ShadowTokenValue, StringTokenValue, ProductCopyTokenValue, AnyStringTokenValue, TokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, TypographyTokenValue, FontFamilyTokenValue, FontWeightTokenValue, DimensionTokenValue, SizeTokenValue, SpaceTokenValue, OpacityTokenValue, FontSizeTokenValue, LineHeightTokenValue, LetterSpacingTokenValue, ParagraphSpacingTokenValue, BorderWidthTokenValue, RadiusTokenValue, DurationTokenValue, ZIndexTokenValue, AnyDimensionTokenValue, } from "./model/tokens/SDKTokenValue";
252
+ export type { AnyToken, AnyTokenValue, BlurTokenValue, BorderTokenValue, ColorTokenValue, GradientStopValue, GradientTokenValue, ShadowTokenValue, StringTokenValue, ProductCopyTokenValue, AnyStringTokenValue, TokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, TypographyTokenValue, DimensionTokenValue, SizeTokenValue, SpaceTokenValue, OpacityTokenValue, FontSizeTokenValue, LineHeightTokenValue, LetterSpacingTokenValue, ParagraphSpacingTokenValue, BorderWidthTokenValue, RadiusTokenValue, DurationTokenValue, ZIndexTokenValue, AnyDimensionTokenValue, } from "./model/tokens/SDKTokenValue";
261
253
  export { TokenTheme } from "./model/themes/SDKTokenTheme";
262
254
  export { TokenThemeOverride } from "./model/themes/SDKTokenThemeOverride";
263
255
  export { TokenUtilPreviewGenerator } from "./tools/token-preview/TokenUtilPreviewGenerator";
@@ -1,7 +1,16 @@
1
- import { PageBlockDefinitionBehavior } from "@supernova-studio/model";
2
1
  import { DocsBlockBehaviorDataType } from "../../../enums/SDKDocsBlockBehaviorDataType";
3
2
  import { DocsBlockBehaviorSelectionType } from "../../../enums/SDKDocsBlockBehaviorSelectionType";
4
- export type DocsBlockBehaviorModel = PageBlockDefinitionBehavior;
3
+ export type DocsBlockBehaviorModel = {
4
+ dataType: DocsBlockBehaviorDataType;
5
+ items?: {
6
+ numberOfItems?: number;
7
+ allowLinks?: boolean;
8
+ };
9
+ entities?: {
10
+ selectionType: DocsBlockBehaviorSelectionType;
11
+ maxSelected?: number;
12
+ };
13
+ };
5
14
  export declare class DocsBlockBehavior {
6
15
  /** Defines what data block uses, and generates */
7
16
  dataType: DocsBlockBehaviorDataType;
@@ -1,11 +1,27 @@
1
- import { PageBlockDefinition } from "@supernova-studio/model";
2
1
  import { DocsBlockMode } from "../../../enums/SDKDocBlockMode";
3
2
  import { DocsBlockCategory } from "../../../enums/SDKDocsBlockCategory";
4
3
  import { DocsImageRef } from "../support/SDKDocsImageRef";
5
- import { DocsBlockBehavior } from "./SDKDocsBlockBehavior";
6
- import { DocsBlockItemDefinition } from "./SDKDocsBlockItemDefinition";
7
- import { DocsBlockOnboarding } from "./SDKDocsBlockOnboarding";
8
- export type DocsBlockDefinitionModel = PageBlockDefinition;
4
+ import { DocsBlockBehavior, DocsBlockBehaviorModel } from "./SDKDocsBlockBehavior";
5
+ import { DocsBlockItemDefinition, DocsBlockItemDefinitionModel } from "./SDKDocsBlockItemDefinition";
6
+ import { DocsBlockOnboarding, DocsBlockOnboardingModel } from "./SDKDocsBlockOnboarding";
7
+ export type DocsBlockDefinitionModel = {
8
+ id: string;
9
+ name: string;
10
+ description: string;
11
+ category: DocsBlockCategory;
12
+ icon?: DocsImageRef;
13
+ documentationLink?: string;
14
+ searchKeywords?: Array<string>;
15
+ item: DocsBlockItemDefinitionModel;
16
+ behavior: DocsBlockBehaviorModel;
17
+ editorOptions?: {
18
+ onboarding?: DocsBlockOnboardingModel;
19
+ };
20
+ appearance?: {
21
+ isBordered?: boolean;
22
+ hasBackground?: boolean;
23
+ };
24
+ };
9
25
  export declare class DocsBlockDefinition {
10
26
  /** Unique id of the block. Block id must be unique across all blocks registered to Supernova in preparation for block store. Reserved ids will be created for all core blocks and they'll be installed by default to every exporter */
11
27
  id: string;
@@ -1,7 +1,14 @@
1
- import { PageBlockDefinitionItem } from "@supernova-studio/model";
2
1
  import { DocsBlockItemPropertyAnyDefinition } from "../properties/SDKDocsBlockProperty";
3
- import { DocsBlockVariant } from "./SDKDocsBlockVariant";
4
- export type DocsBlockItemDefinitionModel = PageBlockDefinitionItem;
2
+ import { DocsBlockVariant, DocsBlockVariantModel } from "./SDKDocsBlockVariant";
3
+ export type DocsBlockItemDefinitionModel = {
4
+ properties: Array<DocsBlockItemPropertyAnyDefinition>;
5
+ appearance?: {
6
+ isBordered?: boolean;
7
+ hasBackground?: boolean;
8
+ };
9
+ variants: Array<DocsBlockVariantModel>;
10
+ defaultVariantKey: string;
11
+ };
5
12
  export declare class DocsBlockItemDefinition {
6
13
  /** All properties that user can potentially input via one block / item */
7
14
  properties: Array<DocsBlockItemPropertyAnyDefinition>;
@@ -1,9 +1,14 @@
1
- import { PageBlockDefinitionLayout } from "@supernova-studio/model";
2
1
  import { DocsBlockItemVariantLayoutAlign } from "../../../enums/SDKDocsBlockItemVariantLayoutAlign";
3
2
  import { DocsBlockItemVariantLayoutColumnResizing } from "../../../enums/SDKDocsBlockItemVariantLayoutColumnResizing";
4
3
  import { DocsBlockItemVariantLayoutGap } from "../../../enums/SDKDocsBlockItemVariantLayoutGap";
5
4
  import { DocsBlockItemVariantLayoutType } from "../../../enums/SDKDocsBlockItemVariantLayoutType";
6
- export type DocsBlockLayoutModel = PageBlockDefinitionLayout;
5
+ export type DocsBlockLayoutModel = {
6
+ type: DocsBlockItemVariantLayoutType;
7
+ children: Array<DocsBlockLayoutModel | string>;
8
+ gap?: DocsBlockItemVariantLayoutGap;
9
+ columnAlign?: DocsBlockItemVariantLayoutAlign;
10
+ columnResizing?: DocsBlockItemVariantLayoutColumnResizing;
11
+ };
7
12
  export declare class DocsBlockLayout {
8
13
  /** Type of a single node of the layout, either column for stacking vertically, or row for stacking horizontally */
9
14
  type: DocsBlockItemVariantLayoutType;
@@ -1,6 +1,19 @@
1
- import { PageBlockDefinitionVariant } from "@supernova-studio/model";
2
1
  import { DocsBlockLayout } from "./SDKDocsBlockLayout";
3
- export type DocsBlockVariantModel = PageBlockDefinitionVariant;
2
+ export type DocsBlockVariantModel = {
3
+ id: string;
4
+ name: string;
5
+ image: string;
6
+ description?: string;
7
+ documentationLink?: string;
8
+ layout: DocsBlockLayout;
9
+ maxColumns?: number;
10
+ defaultColumns?: number;
11
+ appearance?: {
12
+ isBordered?: boolean;
13
+ hasBackground?: boolean;
14
+ isEditorPresentationDifferent?: boolean;
15
+ };
16
+ };
4
17
  export declare class DocsBlockVariant {
5
18
  /** Variant id, validated to be unique within a block, but not necessarily unique across all blocks */
6
19
  id: string;
@@ -6,7 +6,7 @@ export type DocsBlockAssetPropertyOptions = Record<string, never>;
6
6
  /** Asset property - Data */
7
7
  export type DocsBlockAssetPropertyData = DocsBlockPropertyData<Array<{
8
8
  entityId: string;
9
- entityType: "Asset" | "AssetGroup";
9
+ entityType: "asset" | "assetGroup";
10
10
  }>> & {
11
11
  /** Selected asset ids */
12
12
  selectedPropertyIds?: Array<string>;
@@ -6,7 +6,7 @@ export type DocsBlockBooleanPropertyOptions = {
6
6
  /** Default value to set when block is created */
7
7
  defaultValue?: boolean;
8
8
  /** Visual representation of the property */
9
- booleanStyle?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
9
+ style?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
10
10
  };
11
11
  /** Boolean property - Data */
12
12
  export type DocsBlockBooleanPropertyData = DocsBlockPropertyData<boolean> & Record<string, never>;
@@ -3,13 +3,13 @@ import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBloc
3
3
  /** Code Sandbox property - Additional non-value options */
4
4
  export type DocsBlockCodeSandboxPropertyOptions = {
5
5
  /** How should we render the code example in editor */
6
- renderLayoutAs?: "PreviewOnTop" | "PreviewOnBottom" | "PreviewOnLeft" | "PreviewOnRight";
6
+ renderLayoutAs?: "previewOnTop" | "previewOnBottom" | "previewOnLeft" | "previewOnRight";
7
7
  };
8
8
  /** Code Sandbox property - Data */
9
9
  export type DocsBlockCodeSandboxPropertyData = DocsBlockPropertyData<string> & {
10
10
  showCode?: boolean;
11
11
  backgroundColor?: string;
12
- alignPreview?: "Left" | "Center";
12
+ alignPreview?: "left" | "center";
13
13
  };
14
14
  /** Code Sandbox property - Definition model */
15
15
  export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
@@ -3,14 +3,14 @@ import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDe
3
3
  /** Component property - Additional non-value options */
4
4
  export type DocsBlockComponentPropertyOptions = {
5
5
  /** How should the tokens be rendered in editor */
6
- renderLayoutAs?: "List" | "Table";
6
+ renderLayoutAs?: "list" | "table";
7
7
  /** Whether to allow selecting component custom properties. True by default */
8
8
  allowPropertySelection?: boolean;
9
9
  };
10
10
  /** Component property - Data */
11
11
  export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
12
12
  entityId: string;
13
- entityType: "Component" | "ComponentGroup";
13
+ entityType: "component" | "componentGroup";
14
14
  }>> & {
15
15
  /** Selected component ids */
16
16
  selectedPropertyIds?: Array<string>;
@@ -9,7 +9,7 @@ export type DocsBlockMultiSelectPropertyOptions = {
9
9
  name: string;
10
10
  icon?: string;
11
11
  }>;
12
- multiSelectStyle?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
12
+ style?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
13
13
  };
14
14
  /** MultiSelect property - Data */
15
15
  export type DocsBlockMultiSelectPropertyData = DocsBlockPropertyData<Array<string>> & Record<string, never>;
@@ -1,6 +1,14 @@
1
- import { PageBlockDefinitionProperty } from "@supernova-studio/model";
2
1
  import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
3
- export type DocsBlockPropertyDefinitionModel = PageBlockDefinitionProperty;
2
+ export type DocsBlockPropertyDefinitionModel = {
3
+ id: string;
4
+ name: string;
5
+ type: DocsBlockItemPropertyType;
6
+ description?: string;
7
+ options?: object | Record<string, never>;
8
+ variantOptions?: {
9
+ [key: string]: object | Record<string, never>;
10
+ };
11
+ };
4
12
  export type DocsBlockPropertyData<T> = {
5
13
  value: T;
6
14
  };