@supernova-studio/supernova-sdk-beta 1.6.41 → 1.6.43

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 (27) hide show
  1. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +2 -1
  2. package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +2 -2
  3. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +15 -0
  4. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +13 -3
  5. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +11 -1
  6. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +2 -2
  7. package/build/sdk-typescript/src/model/base/SDKDesignSystemVersion.d.ts +15 -3
  8. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +4 -2
  9. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +5 -3
  10. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +3 -1
  11. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +3 -1
  12. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyConfiguration.d.ts +4 -0
  13. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyItem.d.ts +2 -0
  14. package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationLegacyItemConfiguration.d.ts +4 -0
  15. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +6 -6
  16. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +6 -6
  17. package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +2 -2
  18. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegration.d.ts +40 -0
  19. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIntegrationOauthRequest.d.ts +9 -0
  20. package/build/sdk-typescript/src/tests/helpers.d.ts +5 -0
  21. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +1 -0
  22. package/build/sdk-typescript/src/tools/design-tokens/utilities/collection/SDKDTTokenCollection.d.ts +1 -1
  23. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
  24. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +1 -0
  25. package/build/supernova-sdk-typescript.js +1 -1
  26. package/build/supernova-sdk-typescript.js.map +1 -1
  27. package/package.json +7 -7
@@ -1,4 +1,4 @@
1
- import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput } from "@supernova-studio/client";
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, DTODocumentationPageAnchor } from "@supernova-studio/client";
2
2
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
3
3
  import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
4
4
  import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
@@ -173,6 +173,7 @@ export declare class AreaDocumentation {
173
173
  * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
174
174
  * */
175
175
  publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
176
+ getDocumentationPageAnchors(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
176
177
  getDocumentationMockedStructure(): Array<DocsEntity>;
177
178
  getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
178
179
  getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
@@ -1,4 +1,4 @@
1
- import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
1
+ import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
2
2
  import { DataCore } from "../data/SDKDataCore";
3
3
  import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
4
4
  export declare class AreaVersions {
@@ -12,7 +12,7 @@ export declare class AreaVersions {
12
12
  * @param model - new version model
13
13
  * @returns Newly created version object
14
14
  */
15
- createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersion>;
15
+ createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreate>;
16
16
  /** Edits version
17
17
  * @param designSystemId - ID of the design system
18
18
  * @param versionId - ID of version
@@ -4,6 +4,8 @@ import { Membership } from "../../model/membership/SDKMembership";
4
4
  import { UserMembership } from "../../model/users/SDKUserMembership";
5
5
  import { Workspace } from "../../model/workspaces/SDKWorkspace";
6
6
  import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
7
+ import { WorkspaceIntegrations } from "../../model/workspaces/SDKWorkspaceIntegration";
8
+ import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequest } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
7
9
  import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
8
10
  import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
9
11
  import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
@@ -24,6 +26,19 @@ export declare class AreaWorkspaces {
24
26
  * @returns Full workspace object
25
27
  */
26
28
  workspace(workspaceId: string): Promise<Workspace>;
29
+ /** Fetches integrations of one specific workspace by provided id
30
+ * @param workspaceId - ID of the workspace
31
+ * @returns Object with integrations of given workspace
32
+ */
33
+ workspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrations>;
34
+ /** Fetches redirect url for oauth of one specific workspace integration by workspace id and integration type
35
+ * @param workspaceId - ID of the workspace
36
+ * @returns Object with redirect url
37
+ */
38
+ workspaceIntegrationRedirectUrl({ workspaceId, type, }: {
39
+ workspaceId: string;
40
+ type: OAuth2IntegrationTypes;
41
+ }): Promise<WorkspaceIntegrationOauthRequest>;
27
42
  /** Fetches all workspaces user has access to. Use `memberships` instead if you want to also know which role the current user has in which workspace
28
43
  * @param userId - ID of the user
29
44
  * @returns All workspaces user is part of
@@ -1,12 +1,12 @@
1
1
  import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput, // TODO? DTODeleteDocumentationTabGroupInput,
2
- DTOFigmaNodeRenderInput, DTOFigmaNode, DTODocumentationLinkPreviewRequest, DTODeleteDocumentationTabGroupInput } from "@supernova-studio/client";
2
+ DTOFigmaNodeRenderInput, DTOFigmaNode, DTODocumentationLinkPreviewRequest, DTODeleteDocumentationTabGroupInput, DTODocumentationPageAnchor } from "@supernova-studio/client";
3
3
  import { ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject, DocsBlockDefinition } from "../../exports";
4
4
  import { Acl } from "../../model/acl/SDKAcl";
5
5
  import { Asset } from "../../model/assets/SDKAsset";
6
6
  import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
7
7
  import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
8
8
  import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
9
- import { DesignSystemVersion, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
9
+ import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
10
10
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
11
11
  import { Component } from "../../model/components/SDKComponent";
12
12
  import { DesignComponent } from "../../model/components/SDKDesignComponent";
@@ -62,6 +62,8 @@ import { UserMembership } from "../../model/users/SDKUserMembership";
62
62
  import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
63
63
  import { Workspace } from "../../model/workspaces/SDKWorkspace";
64
64
  import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
65
+ import { WorkspaceIntegrations } from "../../model/workspaces/SDKWorkspaceIntegration";
66
+ import { OAuth2IntegrationTypes } from "../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
65
67
  import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
66
68
  import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
67
69
  import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
@@ -299,6 +301,7 @@ export declare class DataCore {
299
301
  documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
300
302
  /** Publish the documentation */
301
303
  documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
304
+ getDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<Array<DTODocumentationPageAnchor>>;
302
305
  /** Retrieve all asset resources */
303
306
  assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
304
307
  /** Retrieve all font resources */
@@ -373,8 +376,15 @@ export declare class DataCore {
373
376
  workspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeatures>;
374
377
  /** Download information about a single workspace and retrieve it resolved */
375
378
  workspace(workspaceId: string): Promise<Workspace>;
379
+ /** Download information about a single workspace's integrations' */
380
+ workspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrations>;
381
+ /** Download redirect url for oauth of specific workspace integration */
382
+ workspaceIntegrationRedirectUrl({ workspaceId, type, }: {
383
+ workspaceId: string;
384
+ type: OAuth2IntegrationTypes;
385
+ }): Promise<any>;
376
386
  createWorkspace(name: string, handle?: string): Promise<Workspace>;
377
- createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersion>;
387
+ createVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreate>;
378
388
  editVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
379
389
  deleteVersion(designSystemId: string, versionId: string): Promise<void>;
380
390
  createBrand(designSystemId: string, versionId: any, model: BrandUpdateModel): Promise<Brand>;
@@ -1,4 +1,4 @@
1
- import { DTODocumentationLinkPreviewRequest, DTOFigmaNode } from "@supernova-studio/client";
1
+ import { DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse } from "@supernova-studio/client";
2
2
  import { AclRemoteModel } from "../../../model/acl/SDKAcl";
3
3
  import { BrandRemoteModel } from "../../../model/base/SDKBrand";
4
4
  import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
@@ -53,6 +53,8 @@ import { UserRemoteModel } from "../../../model/users/SDKUser";
53
53
  import { UserMembershipRemoteModel } from "../../../model/users/SDKUserMembership";
54
54
  import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
55
55
  import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
56
+ import { WorkspaceIntegrationsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegration";
57
+ import { OAuth2IntegrationTypes, WorkspaceIntegrationOauthRequestRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegrationOauthRequest";
56
58
  import { WorkspaceInvitationRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
57
59
  import { WorkspaceInvoiceRemoteModel } from "../../../model/workspaces/SDKWorkspaceInvoice";
58
60
  import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
@@ -81,6 +83,13 @@ export declare class DataCoreReadRequests {
81
83
  getRemoteWorkspaceProductFeatures(workspaceId: string): Promise<SubscriptionProductFeaturesRemoteModel>;
82
84
  /** Remote: Get information about a specific workspace */
83
85
  getRemoteWorkspaceDetail(workspaceId: string): Promise<WorkspaceRemoteModel>;
86
+ /** Remote: Get integrations of a specific workspace */
87
+ getRemoteWorkspaceIntegrations(workspaceId: string): Promise<WorkspaceIntegrationsRemoteModel>;
88
+ /** Remote: Get redirect url for oauth of given workspace integration */
89
+ getRemoteWorkspaceIntegrationRedirectUrl({ workspaceId, type, }: {
90
+ workspaceId: string;
91
+ type: OAuth2IntegrationTypes;
92
+ }): Promise<WorkspaceIntegrationOauthRequestRemoteModel>;
84
93
  /** Remote: Validate can use workspace handle */
85
94
  getRemoteIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
86
95
  /** Remote: Get all users memberships */
@@ -120,6 +129,7 @@ export declare class DataCoreReadRequests {
120
129
  getRemoteDocumentationPageRoomId(designSystemId: string, versionId: string, pageId: string): Promise<string>;
121
130
  /** Remote: Get id of the room for a specific design system and version. This room contains doc structure */
122
131
  getRemoteDocumentationVersionRoomId(designSystemId: string, versionId: string): Promise<string>;
132
+ getRemoteDocumentationPageAnchors(designSystemId: string, versionId: string, pageId: string): Promise<DTOGetDocumentationPageAnchorsResponse>;
123
133
  /** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
124
134
  getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
125
135
  /** Remote: Get user configuration of specific installed exporter */
@@ -2,7 +2,7 @@ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DT
2
2
  import { TokenThemeOverrideTranserObject } from "../../../exports";
3
3
  import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
4
4
  import { DesignSystem, DesignSystemRemoteModel, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
5
- import { DesignSystemVersionRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
5
+ import { DesignSystemVersionCreateRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
6
6
  import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
7
7
  import { Component, ComponentRemoteModel, ComponentUpdateRemoteModel } from "../../../model/components/SDKComponent";
8
8
  import { ElementDataViewColumnType } from "../../../model/elements/SDKElementDataViewColumn";
@@ -53,7 +53,7 @@ export declare class DataCoreWriteRequests {
53
53
  /** Remote: Creates a new workspace */
54
54
  createRemoteWorkspace(name: string, handle?: string): Promise<WorkspaceRemoteModel>;
55
55
  /** Remote: Creates a new version */
56
- createRemoteVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionRemoteModel>;
56
+ createRemoteVersion(designSystemId: string, model: DesignSystemVersionUpdateModel): Promise<DesignSystemVersionCreateRemoteModel>;
57
57
  /** Remote: Updates a version */
58
58
  updateRemoteVersion(designSystemId: string, versionId: string, model: DesignSystemVersionUpdateModel): Promise<void>;
59
59
  /** Remote: Deletes a version */
@@ -10,17 +10,18 @@ export type DesignSystemVersionRemoteModel = {
10
10
  createdAt: string;
11
11
  changeLog: string;
12
12
  };
13
+ export type DesignSystemVersionCreateRemoteModel = Omit<DesignSystemVersionRemoteModel, "id" | "createdAt">;
13
14
  export type DesignSystemVersionUpdateModel = {
14
15
  version: string;
15
16
  name?: string;
16
17
  description?: string;
18
+ changeLog?: string;
17
19
  };
18
20
  export type DesignSystemVersionTransportModel = Pick<DesignSystemVersion, "id" | "designSystemId" | "isReadonly" | "name" | "description" | "version" | "changeLog"> & {
19
21
  createdAt: string;
20
22
  };
21
- export declare class DesignSystemVersion {
22
- /** Unique identifier of design system version */
23
- id: string;
23
+ export type DesignSystemVersionCreateTransportModel = Pick<DesignSystemVersion, "designSystemId" | "isReadonly" | "name" | "description" | "version" | "changeLog">;
24
+ export declare class DesignSystemVersionCreate {
24
25
  /** Identifier of design system this version is created in */
25
26
  designSystemId: string;
26
27
  /** Design system version name */
@@ -33,6 +34,17 @@ export declare class DesignSystemVersion {
33
34
  version: string | null;
34
35
  /** Change log for the version. Will be null if the version is in draft mode */
35
36
  changeLog: string | null;
37
+ constructor(model: DesignSystemVersionCreateRemoteModel);
38
+ /** Constructs representation that can be used to write full object to remote */
39
+ toRemote(): DesignSystemVersionCreateRemoteModel;
40
+ /** Constructs representation that can be used to transport the instantiated object as JSON, for example for SSR <> Client use-cases. Reconstruct to class instance using `fromTransport` */
41
+ toTransport(): DesignSystemVersionCreateTransportModel;
42
+ /** Reconstructs class from the transport model */
43
+ static fromTransport(model: DesignSystemVersionCreateTransportModel): DesignSystemVersionCreate;
44
+ }
45
+ export declare class DesignSystemVersion extends DesignSystemVersionCreate {
46
+ /** Unique identifier of design system version */
47
+ id: string;
36
48
  /** The initial date of the creation of this version */
37
49
  createdAt: Date;
38
50
  constructor(model: DesignSystemVersionRemoteModel);
@@ -1,4 +1,4 @@
1
- import { DocumentationItemConfigurationV2 } from "@supernova-studio/model";
1
+ import { DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
2
2
  import { DocsEntityType } from "../../enums/SDKDocsEntityType";
3
3
  import { DocsEntityConfiguration } from "./SDKDocsEntityConfiguration";
4
4
  export type DocsEntityModel = {
@@ -11,7 +11,7 @@ export type DocsEntityModel = {
11
11
  slug: string;
12
12
  userSlug?: string;
13
13
  path?: string;
14
- configuration: DocumentationItemConfigurationV2;
14
+ configuration: DTODocumentationItemConfigurationV2;
15
15
  createdAt?: string;
16
16
  updatedAt?: string;
17
17
  };
@@ -26,5 +26,7 @@ export declare class DocsEntity {
26
26
  relativeUrl: string | null;
27
27
  createdAt: Date | null;
28
28
  updatedAt: Date | null;
29
+ isPrivate: boolean;
30
+ isHidden: boolean;
29
31
  constructor(model: DocsEntityModel);
30
32
  }
@@ -1,4 +1,4 @@
1
- import { DocumentationItemConfigurationV2 } from "@supernova-studio/model";
1
+ import { DTODocumentationItemConfigurationV2 } from "@supernova-studio/client";
2
2
  import { DocsEntityHeader, DocsEntityHeaderModel } from "./SDKDocsEntityHeader";
3
3
  export type DocsEntityConfigurationModel = {
4
4
  header: DocsEntityHeaderModel;
@@ -7,9 +7,11 @@ export type DocsEntityConfigurationModel = {
7
7
  export declare class DocsEntityConfiguration {
8
8
  header: DocsEntityHeader;
9
9
  showSidebar: boolean;
10
+ isHidden: boolean;
11
+ isPrivate: boolean;
10
12
  title: string;
11
- constructor(model: DocumentationItemConfigurationV2, title: string);
13
+ constructor(model: DTODocumentationItemConfigurationV2, title: string);
12
14
  /** Constructs representation that can be used to write full object to remote */
13
- toRemote(): DocumentationItemConfigurationV2;
15
+ toRemote(): DTODocumentationItemConfigurationV2;
14
16
  static default(): DocsEntityConfiguration;
15
17
  }
@@ -32,7 +32,7 @@ export declare class DocsEntityGroup extends DocsEntity {
32
32
  deployedDocsPageUrl(): string | null;
33
33
  }
34
34
  /** Lightweight page representation used in multiplayer context type-validated against the full version */
35
- export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot"> {
35
+ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup, "id" | "persistentId" | "type" | "title" | "groupBehavior" | "childrenIds" | "isRoot" | "isPrivate" | "isHidden"> {
36
36
  id: string;
37
37
  persistentId: string;
38
38
  type: DocsEntityType.group;
@@ -42,6 +42,8 @@ export declare class DocsEntityMultiplayerGroup implements Pick<DocsEntityGroup,
42
42
  isRoot: boolean;
43
43
  parent: DocsEntityMultiplayerGroup | null;
44
44
  children: Array<DocsEntityMultiplayerGroup | DocsEntityMultiplayerPage>;
45
+ isPrivate: boolean;
46
+ isHidden: boolean;
45
47
  /** Children filtered to be only groups */
46
48
  get subgroups(): Array<DocsEntityMultiplayerGroup>;
47
49
  /** Children filtered to be only pages */
@@ -26,7 +26,7 @@ export declare class DocsEntityPage extends DocsEntity {
26
26
  relativePageUrl(): string | null;
27
27
  }
28
28
  /** Lightweight page representation used in multiplayer context type-validated against the full version */
29
- export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt"> {
29
+ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "id" | "persistentId" | "type" | "title" | "relativeUrl" | "createdAt" | "isPrivate" | "isHidden"> {
30
30
  id: string;
31
31
  persistentId: string;
32
32
  parentId: string | null;
@@ -35,5 +35,7 @@ export declare class DocsEntityMultiplayerPage implements Pick<DocsEntityPage, "
35
35
  title: string;
36
36
  relativeUrl: string | null;
37
37
  createdAt: Date | null;
38
+ isPrivate: boolean;
39
+ isHidden: boolean;
38
40
  constructor(model: DocsEntityPageModel);
39
41
  }
@@ -4,6 +4,8 @@ export type DocumentationLegacyConfigurationModel = {
4
4
  storybookEmbedErrorMessage?: string;
5
5
  renderCodePackageJson?: string;
6
6
  isPublic: boolean;
7
+ isPrivate: boolean;
8
+ isHidden: boolean;
7
9
  serveDefaultVersionOnly: boolean;
8
10
  selectedBrandId: string;
9
11
  host: string;
@@ -11,6 +13,8 @@ export type DocumentationLegacyConfigurationModel = {
11
13
  export declare class DocumentationLegacyConfiguration {
12
14
  tabbedNavigation: boolean;
13
15
  isPublic: boolean;
16
+ isPrivate: boolean;
17
+ isHidden: boolean;
14
18
  serveDefaultVersionOnly: boolean;
15
19
  selectedBrandId: string;
16
20
  host: string;
@@ -22,5 +22,7 @@ export declare class DocumentationLegacyItem {
22
22
  userSlug: string | null;
23
23
  createdAt: Date | null;
24
24
  updatedAt: Date | null;
25
+ isPrivate: boolean;
26
+ isHidden: boolean;
25
27
  constructor(model: DocumentationLegacyItemModel);
26
28
  }
@@ -2,10 +2,14 @@ import { DocumentationLegacyItemHeader, DocumentationLegacyItemHeaderModel } fro
2
2
  export type DocumentationLegacyItemConfigurationModel = {
3
3
  header: DocumentationLegacyItemHeaderModel;
4
4
  showSidebar: boolean;
5
+ isPrivate: boolean;
6
+ isHidden: boolean;
5
7
  };
6
8
  export declare class DocumentationLegacyItemConfiguration {
7
9
  header: DocumentationLegacyItemHeader;
8
10
  showSidebar: boolean;
11
+ isPrivate: boolean;
12
+ isHidden: boolean;
9
13
  constructor(model: DocumentationLegacyItemConfigurationModel);
10
14
  toWriteModel(): DocumentationLegacyItemConfigurationModel;
11
15
  }
@@ -35,21 +35,21 @@ export declare class TokenTheme {
35
35
  toWriteOverrideObject(token: Token): TokenThemeOverrideRemoteModel;
36
36
  valueToWriteObject(value: AnyTokenValue, type: TokenType, token: AnyToken): import("../tokens/remote/SDKRemoteTokenData").ShadowTokenRemoteData | import("../tokens/remote/SDKRemoteTokenData").GradientTokenRemoteData | {
37
37
  aliasTo: string | undefined;
38
- value: import("../tokens/remote/SDKRemoteTokenValue").BorderTokenRemoteValue;
39
- } | {
40
- aliasTo: string | undefined;
41
- value: import("../tokens/remote/SDKRemoteTokenValue").ColorTokenRemoteValue;
38
+ value: import("../tokens/remote/SDKRemoteTokenValue").BlurTokenRemoteValue;
42
39
  } | {
43
40
  aliasTo: string | undefined;
44
- value: import("../tokens/remote/SDKRemoteTokenValue").BlurTokenRemoteValue;
41
+ value: import("../tokens/remote/SDKRemoteTokenValue").BorderTokenRemoteValue;
45
42
  } | {
46
43
  aliasTo: string | undefined;
47
- value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
44
+ value: import("../tokens/remote/SDKRemoteTokenValue").ColorTokenRemoteValue;
48
45
  } | {
49
46
  aliasTo: string | undefined;
50
47
  value: import("../tokens/remote/SDKRemoteTokenValue").AnyDimensionTokenRemoteValue;
51
48
  } | {
52
49
  aliasTo: string | undefined;
53
50
  value: string;
51
+ } | {
52
+ aliasTo: string | undefined;
53
+ value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
54
54
  };
55
55
  }
@@ -26,21 +26,21 @@ export declare class TokenThemeOverride {
26
26
  toWriteObject(): TokenThemeOverrideRemoteModel;
27
27
  valueToWriteObject(value: AnyTokenValue, type: TokenType): ShadowTokenRemoteData | GradientTokenRemoteData | {
28
28
  aliasTo: string | undefined;
29
- value: import("../tokens/remote/SDKRemoteTokenValue").BorderTokenRemoteValue;
30
- } | {
31
- aliasTo: string | undefined;
32
- value: import("../tokens/remote/SDKRemoteTokenValue").ColorTokenRemoteValue;
29
+ value: import("../tokens/remote/SDKRemoteTokenValue").BlurTokenRemoteValue;
33
30
  } | {
34
31
  aliasTo: string | undefined;
35
- value: import("../tokens/remote/SDKRemoteTokenValue").BlurTokenRemoteValue;
32
+ value: import("../tokens/remote/SDKRemoteTokenValue").BorderTokenRemoteValue;
36
33
  } | {
37
34
  aliasTo: string | undefined;
38
- value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
35
+ value: import("../tokens/remote/SDKRemoteTokenValue").ColorTokenRemoteValue;
39
36
  } | {
40
37
  aliasTo: string | undefined;
41
38
  value: import("../tokens/remote/SDKRemoteTokenValue").AnyDimensionTokenRemoteValue;
42
39
  } | {
43
40
  aliasTo: string | undefined;
44
41
  value: string;
42
+ } | {
43
+ aliasTo: string | undefined;
44
+ value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
45
45
  };
46
46
  }
@@ -10,8 +10,8 @@ export declare class TypographyToken extends Token {
10
10
  value: TypographyTokenValue;
11
11
  tokenType: TokenType.typography;
12
12
  constructor(versionId: string, baseToken: TokenRemoteModel, value: TypographyTokenValue, alias: TypographyToken | null, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>);
13
- static create(versionId: string, brandId: string, name: string, description: string, value: object, alias: TypographyToken | null, referenceResolver: DTTokenReferenceResolver, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): TypographyToken;
14
- static typographyValueFromDefinition(definition: any, referenceResolver: DTTokenReferenceResolver): TypographyTokenValue;
13
+ static create(versionId: string, brandId: string, name: string, description: string, value: object, alias: TypographyToken | null, referenceResolver: DTTokenReferenceResolver, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>, reference?: string): TypographyToken;
14
+ static typographyValueFromDefinition(definition: any, referenceResolver: DTTokenReferenceResolver, reference?: string): TypographyTokenValue;
15
15
  toWriteObject(): TypographyTokenRemoteModel;
16
16
  static valueToWriteObject(value: TypographyTokenValue): {
17
17
  aliasTo: string | undefined;
@@ -0,0 +1,40 @@
1
+ export type WorkspaceIntegrationsRemoteModel = {
2
+ integrations: Array<WorkspaceIntegration>;
3
+ };
4
+ export type WorkspaceLinkedIntegrations = {
5
+ Figma?: WorkspaceIntegration[];
6
+ FigmaVariables?: WorkspaceIntegration[];
7
+ Github?: WorkspaceIntegration[];
8
+ TokensStudio?: WorkspaceIntegration[];
9
+ Gitlab?: WorkspaceIntegration[];
10
+ Azure?: WorkspaceIntegration[];
11
+ Bitbucket?: WorkspaceIntegration[];
12
+ };
13
+ type WorkspaceIntegrationCredentialProfile = {
14
+ avatarUrl: string;
15
+ id: string;
16
+ username: string;
17
+ };
18
+ type WorkspaceIntegrationCredential = {
19
+ id: number;
20
+ integrationId: number;
21
+ userId: number;
22
+ createdAt: string;
23
+ accessToken: string;
24
+ refreshToken: string;
25
+ type: "Oauth2" | "PAT" | "GithubApp";
26
+ profile: WorkspaceIntegrationCredentialProfile;
27
+ };
28
+ export type WorkspaceIntegration = {
29
+ id: string;
30
+ createdAt: string;
31
+ type: keyof WorkspaceLinkedIntegrations;
32
+ workspaceId: string;
33
+ integrationCredentials: Array<WorkspaceIntegrationCredential>;
34
+ };
35
+ export declare class WorkspaceIntegrations {
36
+ /** List of integrations of the workspace */
37
+ integrations: Array<WorkspaceIntegration>;
38
+ constructor(model: WorkspaceIntegrationsRemoteModel);
39
+ }
40
+ export {};
@@ -0,0 +1,9 @@
1
+ export type OAuth2IntegrationTypes = "Figma" | "Github" | "Gitlab" | "Bitbucket" | "Azure";
2
+ export type WorkspaceIntegrationOauthRequestRemoteModel = {
3
+ url: string;
4
+ };
5
+ export declare class WorkspaceIntegrationOauthRequest {
6
+ /** Redirect url for oauth of given integration */
7
+ url: string;
8
+ constructor(model: WorkspaceIntegrationOauthRequestRemoteModel);
9
+ }
@@ -1,7 +1,12 @@
1
1
  import { Supernova } from "../core/SDKSupernova";
2
2
  import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "../core/areas/SDKRemoteIdentifiers";
3
+ import { ExecutionContext } from "ava";
3
4
  export declare const testInstance: Supernova;
4
5
  export declare const testVersionIdentifier: RemoteVersionIdentifier;
5
6
  export declare const testWorkspaceVersionIdentifier: RemoteWorkspaceVersionIdentifier;
6
7
  export declare const randomAlphabeticalOnlyIdentifier: (length: number) => string;
7
8
  export declare const randomNumberInRange: (min: number, max: number) => number;
9
+ export declare const retryAssertAsync: (t: ExecutionContext<unknown>, assertFn: (ctx: ExecutionContext<unknown>) => Promise<any>, beforeFn?: ((ctx: ExecutionContext<unknown>) => Promise<any>) | undefined, retriesLeft?: number, interval?: number) => Promise<any>;
10
+ export declare const testRetry: (title: string, fn: (ctx: ExecutionContext<unknown>) => Promise<any>, beforeFn?: ((ctx: ExecutionContext<unknown>) => Promise<any>) | undefined, attempts?: number, interval?: number) => Promise<void>;
11
+ export declare const testRetryBefore: (beforeFn: (ctx: ExecutionContext<unknown>) => Promise<any>) => (title: string, fn: (ctx: ExecutionContext<unknown>) => Promise<any>, attempts?: number, interval?: number) => Promise<void>;
12
+ export declare const testAva: import("ava").TestFn;
@@ -10,6 +10,7 @@ export type DTTokenMergeDiff = {
10
10
  /** Utility allowing merging of two pools of tokens */
11
11
  export declare class DTTokenMerger {
12
12
  static buildKey(path: Array<string>, name: string): string;
13
+ static buildReference(path: Array<string>, name: string): string;
13
14
  buildNodeMap(nodes: Array<DTProcessedTokenNode>): Map<string, DTProcessedTokenNode>;
14
15
  convertBaseTokensToProcessedNode(tokens: Array<AnyToken>, groups: Array<TokenGroup>): Array<DTProcessedTokenNode>;
15
16
  makeTokensDiff(existing: Array<AnyToken>, extracted: Array<DTProcessedTokenNode>, groups: Array<TokenGroup>): DTTokenMergeDiff;
@@ -2,7 +2,7 @@ import { DTProcessedTokenNode } from "../SDKDTJSONConverter";
2
2
  export declare class DTProcessedTokenNodeCollection {
3
3
  readonly index: Map<string, DTProcessedTokenNode>;
4
4
  readonly added: Set<string>;
5
- readonly deleted: Map<string, DTProcessedTokenNode<import("../../../..").AnyToken>>;
5
+ readonly deleted: Map<string, DTProcessedTokenNode>;
6
6
  readonly dirty: Set<string>;
7
7
  readonly list: Array<DTProcessedTokenNode>;
8
8
  constructor(source: Array<DTProcessedTokenNode> | Map<string, DTProcessedTokenNode>);
@@ -62,7 +62,7 @@ export declare class TokenJSONElementTransformer {
62
62
  safeGroupName(group: TokenGroup): string;
63
63
  processedName(name: string, naming: JSONBuilderNamingOption): string;
64
64
  /** Retrieve human-readable token type in unified fashion, used both as token type and as token master group */
65
- typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "visibility" | "shadow" | "measure" | "text" | undefined;
65
+ typeLabel(type: TokenType): "color" | "gradient" | "typography" | "border" | "textCase" | "textDecoration" | "visibility" | "text" | "shadow" | "measure" | undefined;
66
66
  /** Retrieve chain of groups up to a specified group, ordered from parent to children */
67
67
  referenceGroupChain(containingGroup: TokenGroup, allGroups: Array<TokenGroup>): Array<TokenGroup>;
68
68
  }
@@ -279,6 +279,7 @@ export declare class TokenUtils {
279
279
  static inlineValueIntoComplexTokens(token: AnyToken, candidateId: string, candidateValueToInline: AnyTokenValue): void;
280
280
  static getRefIdsFromComplexTokens(token: AnyToken): (string | null | undefined)[];
281
281
  static buildKey(path: Array<string>, name: string): string;
282
+ static buildReference(path: Array<string>, name: string): string;
282
283
  static buildPath(token: Token, groups: Array<TokenGroup>): Array<string>;
283
284
  static mapTypeToPrefix: (type: TokenType) => string;
284
285
  static mapTypeToPrefixBack: (type: TokenType) => string;