@supernova-studio/supernova-sdk-beta 0.7.17 → 0.7.19
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.
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +5 -1
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +19 -0
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +9 -1
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +11 -1
- package/build/sdk-typescript/src/exports.d.ts +1 -0
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +2 -2
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +2 -2
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +1 -1
|
@@ -15,7 +15,11 @@ export declare class AreaDesignSystems {
|
|
|
15
15
|
* @param userId - User id to fetch from
|
|
16
16
|
* @returns All design systems in the specified version
|
|
17
17
|
*/
|
|
18
|
-
designSystemsByUserId(userId: string
|
|
18
|
+
designSystemsByUserId(userId: string, filter?: {
|
|
19
|
+
query?: string;
|
|
20
|
+
limit?: number;
|
|
21
|
+
offset?: number;
|
|
22
|
+
}): Promise<Array<DesignSystemWithWorkspaceShortModel>>;
|
|
19
23
|
/** Fetches a specific design system by its id
|
|
20
24
|
* @param designSystemId - Design system to fetch
|
|
21
25
|
* @returns Design system with the specified id
|
|
@@ -7,6 +7,7 @@ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGro
|
|
|
7
7
|
import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
8
8
|
import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
|
|
9
9
|
import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
|
|
10
|
+
import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
|
|
10
11
|
import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
|
|
11
12
|
import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
|
|
12
13
|
import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
|
|
@@ -55,6 +56,24 @@ export declare class AreaDocumentation {
|
|
|
55
56
|
* @returns nothing
|
|
56
57
|
*/
|
|
57
58
|
updateDocumentationStructure(from: RemoteVersionIdentifier, model: DocumentationLegacyModel): Promise<void>;
|
|
59
|
+
/** @deprecated Used in SDK clients */
|
|
60
|
+
/** Fetches all documentation items
|
|
61
|
+
* @param from - Remote version to fetch from
|
|
62
|
+
* @returns All documentation pages
|
|
63
|
+
*/
|
|
64
|
+
getDocumentationItems(from: RemoteWorkspaceVersionIdentifier): Promise<import("../..").DocumentationLegacyItem[]>;
|
|
65
|
+
/** @deprecated Used in SDK clients */
|
|
66
|
+
/** Fetches all documentation pages
|
|
67
|
+
* @param from - Remote version to fetch from
|
|
68
|
+
* @returns All documentation pages
|
|
69
|
+
*/
|
|
70
|
+
getDocumentationPages(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyPage>>;
|
|
71
|
+
/** @deprecated Used in SDK clients */
|
|
72
|
+
/** Fetches all documentation groups
|
|
73
|
+
* @param from - Remote version to fetch from
|
|
74
|
+
* @returns All documentation groups
|
|
75
|
+
*/
|
|
76
|
+
getDocumentationGroups(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationLegacyGroup>>;
|
|
58
77
|
/** Creates a documentation page within documentation group
|
|
59
78
|
* @param from - Remote version to fetch from
|
|
60
79
|
* @param payload - The update model
|
|
@@ -12,6 +12,7 @@ import { Component } from "../../model/components/SDKComponent";
|
|
|
12
12
|
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
13
13
|
import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGroup";
|
|
14
14
|
import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
|
|
15
|
+
import { DocumentationLegacyItem } from "../../model/documentation/SDKDocumentationLegacyItem";
|
|
15
16
|
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
16
17
|
import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
|
|
17
18
|
import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
|
|
@@ -299,6 +300,9 @@ export declare class DataCore {
|
|
|
299
300
|
documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
|
|
300
301
|
/** Publish the documentation */
|
|
301
302
|
documentationPublish(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuild>;
|
|
303
|
+
/** @deprecated Used in SDK clients */
|
|
304
|
+
/** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
|
|
305
|
+
documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationLegacyItem>>;
|
|
302
306
|
/** Retrieve all asset resources */
|
|
303
307
|
assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
|
|
304
308
|
/** Retrieve all font resources */
|
|
@@ -421,7 +425,11 @@ export declare class DataCore {
|
|
|
421
425
|
/** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
|
|
422
426
|
designSystems(workspaceId: any): Promise<Array<DesignSystem>>;
|
|
423
427
|
/** Download information about all design systems that user has access to under */
|
|
424
|
-
designSystemsByUserId(userId: any
|
|
428
|
+
designSystemsByUserId(userId: any, filter?: {
|
|
429
|
+
query?: string;
|
|
430
|
+
limit?: number;
|
|
431
|
+
offset?: number;
|
|
432
|
+
}): Promise<Array<DesignSystemWithWorkspaceShortModel>>;
|
|
425
433
|
/** Creates a design system */
|
|
426
434
|
createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
|
|
427
435
|
getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinition>>;
|
|
@@ -63,6 +63,7 @@ import { SubscriptionProductFeaturesRemoteModel } from "../../../model/workspace
|
|
|
63
63
|
import { WorkspaceSSOSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
|
|
64
64
|
import { WorkspaceSubscriptionRemoteModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
|
|
65
65
|
import { DataBridge } from "../SDKDataBridge";
|
|
66
|
+
import { DocumentationLegacyGroupModel } from "../../../model/documentation/SDKDocumentationLegacyGroup";
|
|
66
67
|
export declare class DataCoreReadRequests {
|
|
67
68
|
private bridge;
|
|
68
69
|
constructor(bridge: DataBridge);
|
|
@@ -100,7 +101,16 @@ export declare class DataCoreReadRequests {
|
|
|
100
101
|
getRemoteDesignSystem(designSystemId: string): Promise<DesignSystemRemoteModel>;
|
|
101
102
|
/** Remote: Get information about all design systems under specific workspace */
|
|
102
103
|
getRemoteDesignSystems(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
|
|
103
|
-
|
|
104
|
+
/** @deprecated Used in SDK clients */
|
|
105
|
+
getRemoteDocumentationItems(designSystemId: string, versionId: string): Promise<{
|
|
106
|
+
groups: Array<DocumentationLegacyGroupModel>;
|
|
107
|
+
pages: Array<DocumentationLegacyPageModel>;
|
|
108
|
+
}>;
|
|
109
|
+
getRemoteDesignSystemsByUserId(userId: string, filter?: {
|
|
110
|
+
query?: string;
|
|
111
|
+
limit?: number;
|
|
112
|
+
offset?: number;
|
|
113
|
+
}): Promise<Array<DesignSystemWithWorkspaceShortModel>>;
|
|
104
114
|
/** Remote: Get custom domain */
|
|
105
115
|
getRemoteCustomDomain(designSystemId: string): Promise<CustomDomainRemoteModel>;
|
|
106
116
|
/** Remote: Get a single design source */
|
|
@@ -34,6 +34,7 @@ export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspac
|
|
|
34
34
|
export { Brand } from "./model/base/SDKBrand";
|
|
35
35
|
export type { BrandUpdateModel } from "./model/base/SDKBrand";
|
|
36
36
|
export { DesignSystem } from "./model/base/SDKDesignSystem";
|
|
37
|
+
export type { DesignSystemWithWorkspaceShortModel } from "./model/base/SDKDesignSystem";
|
|
37
38
|
export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
|
|
38
39
|
export type { DesignSystemVersionUpdateModel } from "./model/base/SDKDesignSystemVersion";
|
|
39
40
|
export { Membership } from "./model/membership/SDKMembership";
|
|
@@ -47,9 +47,9 @@ export declare class TokenTheme {
|
|
|
47
47
|
value: import("../tokens/remote/SDKRemoteTokenValue").AnyDimensionTokenRemoteValue;
|
|
48
48
|
} | {
|
|
49
49
|
aliasTo: string | undefined;
|
|
50
|
-
value:
|
|
50
|
+
value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
|
|
51
51
|
} | {
|
|
52
52
|
aliasTo: string | undefined;
|
|
53
|
-
value:
|
|
53
|
+
value: string;
|
|
54
54
|
};
|
|
55
55
|
}
|
|
@@ -38,9 +38,9 @@ export declare class TokenThemeOverride {
|
|
|
38
38
|
value: import("../tokens/remote/SDKRemoteTokenValue").AnyDimensionTokenRemoteValue;
|
|
39
39
|
} | {
|
|
40
40
|
aliasTo: string | undefined;
|
|
41
|
-
value:
|
|
41
|
+
value: import("../tokens/remote/SDKRemoteTokenValue").TypographyTokenRemoteValue;
|
|
42
42
|
} | {
|
|
43
43
|
aliasTo: string | undefined;
|
|
44
|
-
value:
|
|
44
|
+
value: string;
|
|
45
45
|
};
|
|
46
46
|
}
|