@supernova-studio/supernova-sdk-beta 1.6.36 → 1.6.38

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 (118) hide show
  1. package/build/sdk-typescript/.eslintrc.d.cts +41 -0
  2. package/build/sdk-typescript/src/core/SDKSupernova.d.ts +4 -0
  3. package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +11 -0
  4. package/build/sdk-typescript/src/core/areas/SDKAreaAutomation.d.ts +14 -14
  5. package/build/sdk-typescript/src/core/areas/SDKAreaBrands.d.ts +1 -1
  6. package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +10 -2
  7. package/build/sdk-typescript/src/core/areas/SDKAreaComponents.d.ts +10 -3
  8. package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +24 -0
  9. package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +78 -37
  10. package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +13 -0
  11. package/build/sdk-typescript/src/core/areas/SDKAreaMultiplayer.d.ts +10 -0
  12. package/build/sdk-typescript/src/core/areas/SDKAreaResources.d.ts +25 -3
  13. package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +2 -2
  14. package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +6 -0
  15. package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +5 -1
  16. package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +95 -39
  17. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +48 -16
  18. package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +44 -53
  19. package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +4 -2
  20. package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +4 -0
  21. package/build/sdk-typescript/src/core/resolvers/SDKDocsEntityMultiplayerItemResolver.d.ts +7 -0
  22. package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +4 -4
  23. package/build/sdk-typescript/src/exports.d.ts +22 -4
  24. package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +1 -7
  25. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +2 -11
  26. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts +13 -23
  27. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockItemDefinition.d.ts +3 -10
  28. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockLayout.d.ts +2 -7
  29. package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts +9 -18
  30. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/{token-group/SDKDocsBlockActualTokenGroup.d.ts → color-ramps/SDKDocsBlockActualColorRamps.d.ts} +1 -1
  31. package/build/sdk-typescript/src/model/docs/blocks/definition/actual/design-tokens/SDKDocsBlockActualDesignTokens.d.ts +6 -0
  32. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +9 -5
  33. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +1 -1
  34. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +4 -2
  35. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +13 -0
  36. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +2 -2
  37. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +2 -1
  38. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +30 -0
  39. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +4 -1
  40. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +19 -0
  41. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +1 -1
  42. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +3 -3
  43. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +2 -10
  44. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -3
  45. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +1 -1
  46. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +13 -3
  47. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +23 -2
  48. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +1 -1
  49. package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +8 -2
  50. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsColorRef.d.ts +2 -2
  51. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsImageRef.d.ts +18 -13
  52. package/build/sdk-typescript/src/model/docs/blocks/support/SDKDocsLinkRef.d.ts +10 -7
  53. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts +11 -24
  54. package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts +2 -7
  55. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntity.d.ts +5 -2
  56. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityConfiguration.d.ts +6 -1
  57. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityGroup.d.ts +24 -2
  58. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityHeader.d.ts +8 -2
  59. package/build/sdk-typescript/src/model/docs/entities/SDKDocsEntityPage.d.ts +14 -0
  60. package/build/sdk-typescript/src/model/documentation/SDKDocumentationLegacyPageAsset.d.ts +1 -1
  61. package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationLegacyPageBlockRenderCode.d.ts +1 -1
  62. package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +1 -1
  63. package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +27 -5
  64. package/build/sdk-typescript/src/model/enums/SDKAlignment.d.ts +5 -0
  65. package/build/sdk-typescript/src/model/enums/SDKCodeLanguage.d.ts +9 -8
  66. package/build/sdk-typescript/src/model/enums/SDKDocsBlockBehaviorDataType.d.ts +1 -1
  67. package/build/sdk-typescript/src/model/enums/{SDKDocsBlockAssetPropertyPreviewContainerSize.d.ts → SDKDocsBlockContainerSize.d.ts} +1 -1
  68. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemPropertyType.d.ts +7 -1
  69. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutAlign.d.ts +3 -3
  70. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutColumnResizing.d.ts +2 -2
  71. package/build/sdk-typescript/src/model/enums/SDKDocsBlockItemVariantLayoutGap.d.ts +4 -4
  72. package/build/sdk-typescript/src/model/enums/SDKDocsBlockMultiRichTextPropertyStyle.d.ts +8 -0
  73. package/build/sdk-typescript/src/model/enums/SDKDocsBlockRichTextPropertyStyle.d.ts +0 -4
  74. package/build/sdk-typescript/src/model/enums/SDKDocsBlockTextPropertyStyle.d.ts +3 -1
  75. package/build/sdk-typescript/src/model/enums/SDKDocsPublishStatus.d.ts +4 -0
  76. package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +19 -19
  77. package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +2 -2
  78. package/build/sdk-typescript/src/model/exporters/SDKConnections.d.ts +9 -0
  79. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuild.d.ts +11 -0
  80. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportBuildResults.d.ts +12 -0
  81. package/build/sdk-typescript/src/model/exporters/exporter_builds/SDKExportDestinations.d.ts +16 -1
  82. package/build/sdk-typescript/src/model/exporters/remote/SDKRemoteConnectionsModel.d.ts +1 -1
  83. package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +4 -0
  84. package/build/sdk-typescript/src/model/resources/SDKResourceFont.d.ts +2 -2
  85. package/build/sdk-typescript/src/model/support/SDKFigmaFrame.d.ts +2 -0
  86. package/build/sdk-typescript/src/model/support/SDKSource.d.ts +14 -5
  87. package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +1 -1
  88. package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +8 -8
  89. package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +13 -8
  90. package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +2 -1
  91. package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +1 -1
  92. package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +1 -0
  93. package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +1 -1
  94. package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +1 -1
  95. package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +1 -1
  96. package/build/sdk-typescript/src/model/tokens/SDKTokenCompator.d.ts +2 -2
  97. package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +3 -3
  98. package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +1 -1
  99. package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceNPMRegistryAccessToken.d.ts +15 -0
  100. package/build/sdk-typescript/src/tests/Areas/AreaAssets.spec.d.ts +1 -0
  101. package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +3 -3
  102. package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +2 -1
  103. package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +1 -1
  104. package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +1 -1
  105. package/build/sdk-typescript/src/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +47 -6
  106. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +1 -1
  107. package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
  108. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +4 -1
  109. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewReferenceInfoGenerator.d.ts +0 -1
  110. package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +4 -1
  111. package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +3 -1
  112. package/build/sdk-typescript/src/utils/CommonUtils.d.ts +5 -0
  113. package/build/sdk-typescript/src/utils/TokenUtils.d.ts +5 -4
  114. package/build/sdk-typescript/src/utils/deepPartial.d.ts +3 -0
  115. package/build/supernova-sdk-typescript.js +1 -1
  116. package/build/supernova-sdk-typescript.js.LICENSE.txt +0 -14
  117. package/build/supernova-sdk-typescript.js.map +1 -1
  118. package/package.json +122 -118
@@ -0,0 +1,41 @@
1
+ declare const _extends: string[];
2
+ export { _extends as extends };
3
+ export declare const root: boolean;
4
+ export declare const overrides: {
5
+ files: string[];
6
+ plugins: string[];
7
+ rules: {
8
+ "@typescript-eslint/unbound-method": string;
9
+ "jest/unbound-method": string;
10
+ };
11
+ }[];
12
+ export declare namespace parserOptions {
13
+ const tsconfigRootDir: string;
14
+ const project: string[];
15
+ }
16
+ export declare const rules: {
17
+ "@typescript-eslint/no-unsafe-assignment": string;
18
+ "@typescript-eslint/no-unsafe-member-access": string;
19
+ "@typescript-eslint/unbound-method": string;
20
+ "@typescript-eslint/no-unused-vars": string;
21
+ "no-restricted-syntax": string;
22
+ "fp/no-mutation": string;
23
+ "no-param-reassign": (string | {
24
+ props: boolean;
25
+ })[];
26
+ "@typescript-eslint/restrict-template-expressions": string;
27
+ "no-nested-ternary": string;
28
+ "no-prototype-builtins": string;
29
+ "prefer-destructuring": string;
30
+ "@typescript-eslint/no-unsafe-argument": string;
31
+ "@typescript-eslint/no-unsafe-return": string;
32
+ "@typescript-eslint/no-unsafe-call": string;
33
+ "@typescript-eslint/no-explicit-any": string;
34
+ "@typescript-eslint/no-var-requires": string;
35
+ "no-await-in-loop": string;
36
+ "no-continue": string;
37
+ "@typescript-eslint/no-useless-constructor": string;
38
+ "no-console": string;
39
+ "@typescript-eslint/require-await": string;
40
+ "max-classes-per-file": string;
41
+ };
@@ -8,6 +8,7 @@ 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";
11
12
  import { AreaNetwork } from "./areas/SDKAreaNetwork";
12
13
  import { AreaResources } from "./areas/SDKAreaResources";
13
14
  import { AreaStorage } from "./areas/SDKAreaStorage";
@@ -57,6 +58,8 @@ export declare class Supernova {
57
58
  storage: AreaStorage;
58
59
  /** Get access to network in exporter packages */
59
60
  network: AreaNetwork;
61
+ /** Get access to multiplayer capabilities */
62
+ multiplayer: AreaMultiplayer;
60
63
  /**
61
64
  * Create new Supernova.io SDK object.
62
65
  * @param apiKey API key to use for authentication
@@ -69,5 +72,6 @@ export declare class Supernova {
69
72
  apiUrl?: string;
70
73
  requestHook?: DataBridgeRequestHook;
71
74
  bypassEnvFetch?: boolean;
75
+ proxyUrl?: string;
72
76
  });
73
77
  }
@@ -1,3 +1,4 @@
1
+ import { DTOFigmaNode } from "@supernova-studio/client";
1
2
  import { Asset } from "../../model/assets/SDKAsset";
2
3
  import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
3
4
  import { AssetFormat } from "../../model/enums/SDKAssetFormat";
@@ -32,4 +33,14 @@ export declare class AreaAssets {
32
33
  * @returns All assets that were provided in the request, rendered in the specified format and scale
33
34
  */
34
35
  getRenderedAssets(from: RemoteVersionIdentifier, assets: Array<Asset>, groups: Array<AssetGroup>, format: AssetFormat, scale: AssetScale): Promise<Array<RenderedAsset>>;
36
+ /** Renders figma frames based on the source and node id. The result is a URL to the hosted image of the Figma frame that is stable across updates.
37
+ *
38
+ * @returns Rendered Figma frames
39
+ */
40
+ getRenderedFigmaFrames(from: RemoteVersionIdentifier, framesToRender: Array<{
41
+ sourceId: string;
42
+ figmaFileNodeId: string;
43
+ }>): Promise<Array<DTOFigmaNode>>;
44
+ /** Passes data through Supernova CORS proxy to prevent issues with accessing foreign data from browser */
45
+ dataThroughCorsProxy(urlToRelay: string): Promise<ArrayBuffer | undefined>;
35
46
  }
@@ -1,4 +1,3 @@
1
- import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
2
1
  import { CodegenAccount } from "../../model/exporters/CodegenAccount";
3
2
  import { CodegenAzureOrganization } from "../../model/exporters/CodegenAzureOrganization";
4
3
  import { CodegenAzureProject } from "../../model/exporters/CodegenAzureProject";
@@ -21,7 +20,7 @@ import { ExportBuild } from "../../model/exporters/exporter_builds/SDKExportBuil
21
20
  import { ExportBuildResultLog } from "../../model/exporters/exporter_builds/SDKExportBuildResults";
22
21
  import { ImportJob } from "../../model/jobs/SDKImportJob";
23
22
  import { DataCore } from "../data/SDKDataCore";
24
- import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
23
+ import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
25
24
  export declare class AreaAutomation {
26
25
  /** Internal: Engine */
27
26
  private dataCore;
@@ -163,6 +162,19 @@ export declare class AreaAutomation {
163
162
  * @param payload - Payload to update exporter with
164
163
  */
165
164
  updateExporter(workspaceId: string, exporterId: string, payload: NewExporterPayload): Promise<Exporter>;
165
+ /** Updates exporter configuration property value
166
+ * @param designSystemId
167
+ * @param exporterId
168
+ * @param propertyKey
169
+ * @param propertyValue
170
+ */
171
+ updateExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: any): Promise<void>;
172
+ /** Deletes exporter configuration property value
173
+ * @param designSystemId
174
+ * @param exporterId
175
+ * @param propertyKey
176
+ */
177
+ deleteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<void>;
166
178
  /** Deletes exporter
167
179
  * @param workspaceId - Identifier of the workspace where the exporter is installed
168
180
  * @param exporterId - Identifier of the exporter to delete
@@ -185,18 +197,6 @@ export declare class AreaAutomation {
185
197
  * @returns All custom variants
186
198
  */
187
199
  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
- }>;
200
200
  /** Gets all import jobs that are currently in progress.
201
201
  * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
202
202
  * @returns Nothing
@@ -12,7 +12,7 @@ export declare class AreaBrands {
12
12
  getBrands(from: RemoteVersionIdentifier): Promise<Array<Brand>>;
13
13
  /** Fetches a single brand
14
14
  * @param from - Remote brand to fetch from
15
- * @returns All brands in the specified version
15
+ * @returns Brand in the specified version
16
16
  */
17
17
  getBrand(from: RemoteBrandIdentifier): Promise<Brand>;
18
18
  /** Creates new brand and retrieves the newly created brand object.
@@ -2,7 +2,7 @@ import { Component } from "../../model/components/SDKComponent";
2
2
  import { ElementProperty } from "../../model/elements/SDKElementProperty";
3
3
  import { TokenGroup } from "../../model/groups/SDKTokenGroup";
4
4
  import { ImportJob } from "../../model/jobs/SDKImportJob";
5
- import { TokenTheme } from "../../model/themes/SDKTokenTheme";
5
+ import { TokenThemeOverrideTranserObject } from "../../model/themes/SDKTokenThemeOverride";
6
6
  import { AnyToken } from "../../model/tokens/SDKTokenValue";
7
7
  import { DataCore } from "../data/SDKDataCore";
8
8
  import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
@@ -15,7 +15,15 @@ export type TokenUpdateTransactionData = {
15
15
  value: string | boolean | number;
16
16
  }>;
17
17
  propertyValuesToDelete?: Array<string>;
18
- themesToUpdate?: Array<TokenTheme>;
18
+ themeValuesToCreate?: Array<{
19
+ themeId: string;
20
+ themeOverrideTransferObject: TokenThemeOverrideTranserObject;
21
+ }>;
22
+ themeValuesToUpdate?: Array<{
23
+ themeId: string;
24
+ themeOverrideTransferObject: TokenThemeOverrideTranserObject;
25
+ }>;
26
+ themeValuesToDelete?: Array<string>;
19
27
  };
20
28
  export type ComponentUpdateTransactionData = {
21
29
  component: Component;
@@ -16,7 +16,9 @@ export declare class AreaComponents {
16
16
  * @param from - Remote version to fetch from
17
17
  * @returns All components in the specified version
18
18
  */
19
- getComponents(from: RemoteVersionIdentifier): Promise<Array<Component>>;
19
+ getComponents(from: RemoteVersionIdentifier, filter?: {
20
+ brandId?: string;
21
+ }): Promise<Array<Component>>;
20
22
  /** Fetches all remote component groups in the version
21
23
  * @param from - Remote version to fetch from
22
24
  * @returns All component groups in the specified version
@@ -26,12 +28,17 @@ export declare class AreaComponents {
26
28
  * @param from - Remote version to fetch from
27
29
  * @returns All design components in the specified version
28
30
  */
29
- getDesignComponents(from: RemoteVersionIdentifier): Promise<Array<DesignComponent>>;
31
+ getDesignComponents(from: RemoteVersionIdentifier, filter?: {
32
+ brandId?: string;
33
+ }): Promise<Array<DesignComponent>>;
30
34
  /** Fetches all remote design component groups in the version
31
35
  * @param from - Remote version to fetch from
36
+ * @param filter - Optional filter
32
37
  * @returns All design component groups in the specified version
33
38
  */
34
- getDesignComponentGroups(from: RemoteVersionIdentifier): Promise<Array<DesignComponentGroup>>;
39
+ getDesignComponentGroups(from: RemoteVersionIdentifier, filter?: {
40
+ brandId?: string;
41
+ }): Promise<Array<DesignComponentGroup>>;
35
42
  /** Retrieves all remote properties for components
36
43
  * @param from - Remote version to fetch from
37
44
  * @returns All component properties in the specified version
@@ -1,3 +1,4 @@
1
+ import { DTODocumentationLinkPreviewRequest } from "@supernova-studio/client";
1
2
  import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
2
3
  import { CustomDomain } from "../../model/support/SDKCustomDomain";
3
4
  import { DataCore } from "../data/SDKDataCore";
@@ -25,6 +26,24 @@ export declare class AreaDesignSystems {
25
26
  * @returns Newly created design system object
26
27
  */
27
28
  createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
29
+ getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
30
+ getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
31
+ linkPreview: {
32
+ title?: string | undefined;
33
+ description?: string | undefined;
34
+ thumbnail?: {
35
+ type: "Resource" | "FigmaNode";
36
+ resource?: {
37
+ url: string;
38
+ resourceId: string;
39
+ } | undefined;
40
+ figmaNode?: {
41
+ sourceId: string;
42
+ frameReferenceId: string;
43
+ } | undefined;
44
+ } | undefined;
45
+ };
46
+ }>;
28
47
  /** Updates design system metadata for a specific design system
29
48
  * @param designSystemId - ID of the design system
30
49
  * @param name - New DS name
@@ -72,4 +91,9 @@ export declare class AreaDesignSystems {
72
91
  * @returns nothing
73
92
  */
74
93
  deleteDesignSystemCustomDomain(designSystemId: string): Promise<void>;
94
+ /** starts ssl generation for custom domain
95
+ * @param designSystemId - ID of the design system
96
+ * @returns nothing
97
+ */
98
+ startSslGenerationForCustomDomain(designSystemId: string): Promise<void>;
75
99
  }
@@ -1,11 +1,16 @@
1
+ import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTODeleteDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOMoveDocumentationGroupInput, DTOCreateDocumentationTabInput } from "@supernova-studio/client";
1
2
  import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
2
3
  import { DocsBlockDefinition } from "../../model/docs/blocks/definition/SDKDocsBlockDefinition";
3
4
  import { DocsBlock } from "../../model/docs/blocks/usage/SDKDocsBlock";
4
5
  import { DocsEntity } from "../../model/docs/entities/SDKDocsEntity";
6
+ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
7
+ import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
5
8
  import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
6
- import { DocumentationLegacyGroup, DocumentationLegacyGroupModel } from "../../model/documentation/SDKDocumentationLegacyGroup";
7
- import { DocumentationLegacyPage, DocumentationLegacyPageModel } from "../../model/documentation/SDKDocumentationLegacyPage";
8
- import { DataCore, DeepPartial } from "../data/SDKDataCore";
9
+ import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
10
+ import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
11
+ import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
12
+ import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
13
+ import { DataCore } from "../data/SDKDataCore";
9
14
  import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
10
15
  export declare class AreaDocumentation {
11
16
  /** Internal: Engine */
@@ -16,105 +21,129 @@ export declare class AreaDocumentation {
16
21
  * @returns Documentation object
17
22
  */
18
23
  getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacy>;
24
+ getDocumentationStructure(from: RemoteWorkspaceVersionIdentifier): Promise<(DocsEntityPageModel | DocsEntityGroupModel)[]>;
19
25
  /** Fetches url string where to find documentation
20
26
  * @param from - Remote version to fetch from
21
27
  * @returns documentation url string
22
28
  */
23
29
  getDocumentationUrl(from: RemoteVersionIdentifier): Promise<string>;
30
+ /** Retrieve information for an ongoing publishing build if any exists. */
31
+ isPublishing(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment): Promise<{
32
+ status: DocsPublishStatus.inProgress;
33
+ job: ExportBuild;
34
+ } | {
35
+ status: DocsPublishStatus.idle;
36
+ job: null;
37
+ }>;
38
+ /** Fetches a documentation build.
39
+ * @param workspaceId - Identifier of the workspace associated with the build.
40
+ * @param buildId - Identifier of the build.
41
+ */
42
+ getDocumentationBuild(workspaceId: string, buildId: string): Promise<ExportBuild>;
43
+ /** Fetches documentation builds filtered according to the params.
44
+ * @param workspaceId - Identifier of the workspace associated with the builds.
45
+ * @param versionId - Identifier of the design system version associated with the builds.
46
+ * @param environment - Environment of the builds.
47
+ * @param status - Status of the builds.
48
+ * @param createdByUserId - Identifier of the user who created the builds.
49
+ * @param limit - Number of builds to return.
50
+ */
51
+ getDocumentationBuilds(workspaceId: string, versionId: string, environment: DocumentationEnvironment, status?: ExportBuildStatus, createdByUserId?: string, limit?: number): Promise<Array<ExportBuild>>;
24
52
  /** Updates documentation structure
25
53
  * @param from - Remote version to fetch from
26
54
  * @param model - documentation legacy model
27
55
  * @returns nothing
28
56
  */
29
57
  updateDocumentationStructure(from: RemoteVersionIdentifier, model: DocumentationLegacyModel): Promise<void>;
30
- /** Fetches all documentation groups
31
- * @param from - Remote version to fetch from
32
- * @returns All documentation groups
33
- */
34
- getDocumentationGroups(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyGroup>>;
35
58
  /** Creates a documentation page within documentation group
36
59
  * @param from - Remote version to fetch from
37
- * @param parentItemPersistentId - Peristent ID of the parent group
38
- * @param newTitle - title of the newly created page
60
+ * @param payload - The update model
39
61
  * @returns Newly created documentation page
40
62
  */
41
- createDocumentationPage(from: RemoteWorkspaceVersionIdentifier, parentItemPersistentId: string, newTitle?: string): Promise<DocumentationLegacyPage>;
63
+ createDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
42
64
  /** Creates a documentation group within documentation group
43
65
  * @param from - Remote version to fetch from
44
66
  * @param parentItemPersistentId - Peristent ID of the parent group
45
67
  * @param data - The update model
46
68
  * @returns Newly created documentation group
47
69
  */
48
- createDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, parentItemPersistentId: string, data: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
70
+ createDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
71
+ /** Creates a documentation tab group within documentation group
72
+ * @param from - Remote version to fetch from
73
+ * @param data - The update model
74
+ * @returns Newly created documentation group
75
+ */
76
+ createDocumentationTab(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTOCreateDocumentationTabInput, "persistentId">): Promise<string>;
49
77
  /** Updates a documentation group within documentation group
50
78
  * @param from - Remote version to fetch from
51
79
  * @param group - Group to update
52
80
  * @param updateModel - Group update model with optional fields
53
81
  * @returns Newly created documentation group
54
82
  */
55
- updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, group: DocumentationLegacyGroup, updateModel: Partial<DocumentationLegacyGroupModel>): Promise<DocumentationLegacyGroup>;
83
+ updateDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationGroupInput): Promise<any>;
84
+ /** Moves a documentation page
85
+ * @param from - Remote version to fetch from
86
+ * @param payload - The update model
87
+ * @returns nothing
88
+ */
89
+ moveDocumentationPage(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationPageInputV2): Promise<any>;
90
+ /** Moves a documentation group
91
+ * @param from - Remote version to fetch from
92
+ * @param payload - The update model
93
+ * @returns nothing
94
+ */
95
+ moveDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTOMoveDocumentationGroupInput): Promise<any>;
56
96
  /** Deletes a documentation group
57
97
  * @param from - Remote version to fetch from
58
98
  * @param group - Group to delete
59
99
  * @returns nothing
60
100
  */
61
- deleteDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, group: DocumentationLegacyGroup): Promise<void>;
101
+ deleteDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
62
102
  /** Deletes a documentation group and its tree
63
103
  * @param from - Remote version to fetch from
64
104
  * @param group - Group to delete
65
105
  * @returns nothing
66
106
  */
67
- deleteDocumentationGroupAndTree(from: RemoteWorkspaceVersionIdentifier, group: DocumentationLegacyGroup): Promise<void>;
107
+ deleteDocumentationGroupAndTree(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
68
108
  /** Deletes a documentation page
69
109
  * @param from - Remote version to fetch from
70
110
  * @param page - Page to delete
71
111
  * @returns nothing
72
112
  */
73
- deleteDocumentationPage(from: RemoteWorkspaceVersionIdentifier, idInVersion: string): Promise<void>;
74
- /** Updates a documentation tab or page
113
+ deleteDocumentationPage(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
114
+ /** Deletes a documentation tab group
75
115
  * @param from - Remote version to fetch from
76
- * @param page - page to update
77
- * @param updateModel - data to update page with
78
- * @returns page
116
+ * @param page - Page to delete
117
+ * @returns nothing
79
118
  */
80
- updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage, updateModel: DeepPartial<DocumentationLegacyPageModel>): Promise<void>;
81
- /** Updates a documentation page header image
119
+ deleteDocumentationTabGroup(from: RemoteWorkspaceVersionIdentifier, id: string): Promise<void>;
120
+ /** Updates a documentation tab or page
82
121
  * @param from - Remote version to fetch from
83
122
  * @param page - page to update
84
- * @param file - file to update a page header with
123
+ * @param updateModel - data to update page with
85
124
  * @returns page
86
125
  */
87
- updateDocumentationHeaderImage(from: RemoteWorkspaceVersionIdentifier, page: DocumentationLegacyPage | DocumentationLegacyGroup, file: File | null): Promise<DocumentationLegacyPage | DocumentationLegacyGroup>;
126
+ updateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: DTOUpdateDocumentationPageInputV2): Promise<any>;
88
127
  /** Duplicates a documentation tab or page
89
128
  * @param from - Remote version to fetch from
90
129
  * @param idInVersion - id of page or tab to be duplicated
91
130
  * @param newPersistentId - suggested persistent id of a new page or tab
92
131
  * @returns Promise<DocumentationLegacyPage>
93
132
  */
94
- duplicateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, idInVersion: string, newPersistentId?: string): Promise<DocumentationLegacyPage>;
133
+ duplicateDocumentationPageOrTab(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTODuplicateDocumentationPageInputV2, "persistentId">): Promise<string>;
95
134
  /** Duplicates a documentation group or tabbed page
96
135
  * @param from - Remote version to fetch from
97
136
  * @param idInVersion - id of page or tab to be duplicated
98
137
  * @param newPersistentId - suggested persistent id of a new group or tabbed page
99
138
  * @returns nothing
100
139
  */
101
- duplicateDocumentationGroupOrTabbedPage(from: RemoteWorkspaceVersionIdentifier, idInVersion: string, newPersistentId?: string): Promise<void>;
140
+ duplicateDocumentationGroupOrTabbedPage(from: RemoteWorkspaceVersionIdentifier, payload: Omit<DTODuplicateDocumentationGroupInput, "persistentId">): Promise<void>;
102
141
  /** Ungroups a documentation group
103
142
  * @param from - Remote version to fetch from
104
143
  * @param idInVersion - id of a group
105
144
  * @returns nothing
106
145
  */
107
- ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, idInVersion: string): Promise<void>;
108
- /** Fetches all documentation items
109
- * @param from - Remote version to fetch from
110
- * @returns All documentation pages
111
- */
112
- getDocumentationItems(from: RemoteWorkspaceVersionIdentifier): Promise<import("../..").DocumentationLegacyItem[]>;
113
- /** Fetches all documentation pages
114
- * @param from - Remote version to fetch from
115
- * @returns All documentation pages
116
- */
117
- getDocumentationPages(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyPage>>;
146
+ ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
118
147
  /** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
119
148
  * Not implemented for now
120
149
  * @param from - Remote version to fetch from
@@ -132,6 +161,18 @@ export declare class AreaDocumentation {
132
161
  * @returns Room ID that can be immediately used to join the multiplayer room
133
162
  */
134
163
  getDocumentationPageRoomId(from: RemoteWorkspaceVersionIdentifier, pageId: string): Promise<string>;
164
+ /** Get id of the room for a specific design system and version. This room contains doc structure
165
+ * @param from - Remote version to fetch from
166
+ * @returns Room ID that can be immediately used to join the multiplayer room
167
+ */
168
+ getDocumentationVersionRoomId(from: RemoteWorkspaceVersionIdentifier): Promise<string>;
169
+ /** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline.
170
+ * You can request status of the build with associated `isPublishing` method.
171
+ * @param to - Remote version where the build should be created
172
+ * @param environment - Environment to publish to
173
+ * @param isForcing - If true, a new build will be created regardless if an in-progress build already exists.
174
+ * */
175
+ publish(to: RemoteWorkspaceVersionIdentifier, environment: DocumentationEnvironment, isForcing?: boolean): Promise<ExportBuild>;
135
176
  getDocumentationMockedStructure(): Array<DocsEntity>;
136
177
  getDocumentationMockedPageContent(pageId: string): Array<DocsBlock | DocsSection>;
137
178
  getDocumentationMockedEditorBlockDefinitions(): Array<DocsBlockDefinition>;
@@ -5,6 +5,10 @@ export declare class AreaIntegrations {
5
5
  /** Internal: Engine */
6
6
  private dataCore;
7
7
  constructor(dataCore: DataCore);
8
+ /**
9
+ * @returns Array of AuthenticationTokens
10
+ */
11
+ getAuthenticationTokens(): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokens>;
8
12
  /** Returns URL that can be used to authenticate current user (identified by the token) with Figma
9
13
  * @returns Figma OAuth URL
10
14
  */
@@ -25,6 +29,11 @@ export declare class AreaIntegrations {
25
29
  * @returns Azure OAuth URL
26
30
  */
27
31
  getAzureOAuthURL(): Promise<string>;
32
+ /** Creates a Personal Access Token.
33
+ * @param name - Name of the token.
34
+ * @param scope - Scope of the token.
35
+ */
36
+ createAuthenticationToken(name: string, scope?: string): Promise<import("../../model/exporters/SDKConnections").CreateAuthenticationTokenPayload>;
28
37
  /** Creates user GitHub personal access token integration.
29
38
  * @param customUrl - Custom GitHub URL. If not provided, default GitHub URL will be used.
30
39
  * @param token - GitHub access token.
@@ -50,6 +59,10 @@ export declare class AreaIntegrations {
50
59
  * @param name - Name of the integration.
51
60
  */
52
61
  createAzurePersonalAccessTokenConnection(connection: AzurePersonalAccessTokenConnectionPayload): Promise<ConnectionRemoteModel>;
62
+ /**
63
+ * @returns Array of AuthenticationTokens
64
+ */
65
+ deleteAuthenticationToken(id: string): Promise<import("../../model/exporters/SDKConnections").AuthenticationTokenPayload>;
53
66
  /** Deletes user Figma OAuth integration.
54
67
  * @param userId - User id to delete integration for. Can only be invoked on user id that is currently authenticated.
55
68
  * @returns Nothing
@@ -0,0 +1,10 @@
1
+ import { DataCore } from "../data/SDKDataCore";
2
+ export declare class AreaMultiplayer {
3
+ /** Internal: Engine */
4
+ private dataCore;
5
+ constructor(dataCore: DataCore);
6
+ /** Return multiplayer access token for specific room. */
7
+ getMultiplayerToken(room: string): Promise<{
8
+ token: string;
9
+ }>;
10
+ }
@@ -1,4 +1,5 @@
1
- import { ResourceAsset, ResourceFont } from "../../exports";
1
+ import { DTOFigmaNode } from "@supernova-studio/client";
2
+ import { DocsImageRef, ResourceAsset, ResourceFont } from "../../exports";
2
3
  import { DataCore } from "../data/SDKDataCore";
3
4
  import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
4
5
  export declare class AreaResources {
@@ -15,10 +16,31 @@ export declare class AreaResources {
15
16
  * @returns All font resources in the specified version
16
17
  */
17
18
  getFontResources(from: RemoteVersionIdentifier): Promise<Array<ResourceFont>>;
19
+ /** Fetches all Figma frames that were rendered font resources in the version
20
+ * @param from - Remote version to fetch from
21
+ * @returns All font resources in the specified version
22
+ */
23
+ getFigmaFrames(from: RemoteVersionIdentifier): Promise<Array<DTOFigmaNode>>;
24
+ /**
25
+ * @param from - Remote version to fetch from
26
+ * @param frameReferenceId - Unique stable identifier of the Figma frame (Supernova id, not Figma id)
27
+ * @returns URL of the hosted image of the Figma frame that is stable across updates
28
+ */
29
+ getFigmaFrameHostedUrl(from: RemoteVersionIdentifier, frameReferenceId: string): string;
30
+ /** Retrieves stable URL
31
+ * @param from - Remote version to fetch from
32
+ * @param frameReferenceId - Unique stable identifier of the Figma frame (Supernova id, not Figma id)
33
+ * @returns URL of the hosted image resource, either uploaded file or Figma frame
34
+ */
35
+ getImageRefHostedUrl(from: RemoteVersionIdentifier, imageRef: DocsImageRef | undefined): string | undefined;
18
36
  /** Uploads new asset resource */
19
37
  uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
20
38
  /** Uploads new font resource */
21
- uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont>;
22
- /** Deletes resource of any type */
39
+ uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont | null>;
40
+ /** Uploads new font resources */
41
+ uploadFontResources(from: RemoteVersionIdentifier, fonts: FileList): Promise<ResourceFont[]>;
42
+ /** Deletes single resource of any type */
23
43
  deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
44
+ /** Deletes multiple resource of any type */
45
+ deleteResources(from: RemoteVersionIdentifier, resourceIds: string[]): Promise<void>;
24
46
  }
@@ -197,8 +197,8 @@ export declare class AreaTokens {
197
197
  /** Deletes remote token group and all its descendants. All items (groups and tokens) underneath will be deleted. Calling this method on group that doesn't exist in the version will result in error
198
198
  * @param to - Remote version to write to
199
199
  * @param tokenGroupToDelete - Token group to delete
200
- * @param allTokens - Tokens for lookup
201
- * @param allTokenGroup - Token group for lookup
200
+ * @param tokens - All available tokens
201
+ * @param tokenGroups - All available token groups
202
202
  * @returns Nothing
203
203
  */
204
204
  deleteTokenGroup(to: RemoteVersionIdentifier, tokenGroupToDelete: TokenGroup, tokens: Array<Token>, tokenGroups: Array<TokenGroup>): Promise<void>;
@@ -6,6 +6,7 @@ import { Workspace } from "../../model/workspaces/SDKWorkspace";
6
6
  import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
7
7
  import { WorkspaceInvitation, WorkspaceInvitationUpdateModel } from "../../model/workspaces/SDKWorkspaceInvitation";
8
8
  import { WorkspaceInvoice } from "../../model/workspaces/SDKWorkspaceInvoice";
9
+ import { WorkspaceNPMRegistryAccessTokenRemoteModel } from "../../model/workspaces/SDKWorkspaceNPMRegistryAccessToken";
9
10
  import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
10
11
  import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
11
12
  import { WorkspaceProduct } from "../../model/workspaces/SDKWorkspaceProduct";
@@ -64,6 +65,11 @@ export declare class AreaWorkspaces {
64
65
  * @returns Workspace NPM registry settings or null if the workspace is not using NPM registry
65
66
  */
66
67
  workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
68
+ /** Fetches workspace NPM registry access token
69
+ * @param workspaceId - ID of the workspace
70
+ * @returns Workspace NPM registry access token
71
+ */
72
+ workspaceNPMRegistryAccessToken(workspaceId: string): Promise<WorkspaceNPMRegistryAccessTokenRemoteModel | null>;
67
73
  /** Fetches workspace SSO settings
68
74
  * @param workspaceId - ID of the workspace
69
75
  * @returns Workspace SSO settings or null if the workspace is not using SSO
@@ -1,3 +1,4 @@
1
+ import { HttpsProxyAgent } from "https-proxy-agent";
1
2
  type DataBridgeRequestHookResult = {
2
3
  skipDefaultAuth?: boolean;
3
4
  };
@@ -21,6 +22,7 @@ export type DataBridgeConfiguration = {
21
22
  requestHook: DataBridgeRequestHook | null;
22
23
  debugRequestObserver?: DebugRequestObserver | null;
23
24
  debugResponseObserver?: DebugResponseObserver | null;
25
+ proxyUrl?: string | null;
24
26
  };
25
27
  export declare class DataBridge {
26
28
  authToken: string;
@@ -28,15 +30,17 @@ export declare class DataBridge {
28
30
  apiVersion: string;
29
31
  target: string | null;
30
32
  bypassEnvFetch: boolean;
33
+ proxyAgent: HttpsProxyAgent<string> | undefined;
31
34
  requestHook: DataBridgeRequestHook | null;
32
35
  debugRequestObserver: DebugRequestObserver | null;
33
36
  debugResponseObserver: DebugResponseObserver | null;
34
37
  constructor(conf: DataBridgeConfiguration);
35
38
  delete(endpoint: string): Promise<any>;
36
39
  get(endpoint: string): Promise<any>;
40
+ getAsData(endpoint: string): Promise<any>;
37
41
  put(endpoint: string, payload: any | null): Promise<any>;
38
42
  post(endpoint: string, payload: any | null): Promise<any>;
39
- upload(endpoint: string, fileKey: string, file: File, method?: "PUT" | "POST"): Promise<any>;
43
+ upload(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<any>;
40
44
  private request;
41
45
  private handleResponse;
42
46
  private buildRequestConfig;