@supernova-studio/supernova-sdk-beta 0.7.17 → 0.7.18

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.
@@ -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,18 @@ 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>>;
58
71
  /** Creates a documentation page within documentation group
59
72
  * @param from - Remote version to fetch from
60
73
  * @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 */
@@ -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,6 +101,11 @@ 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>>;
104
+ /** @deprecated Used in SDK clients */
105
+ getRemoteDocumentationItems(designSystemId: string, versionId: string): Promise<{
106
+ groups: Array<DocumentationLegacyGroupModel>;
107
+ pages: Array<DocumentationLegacyPageModel>;
108
+ }>;
103
109
  getRemoteDesignSystemsByUserId(userId: string): Promise<Array<DesignSystemWithWorkspaceShortModel>>;
104
110
  /** Remote: Get custom domain */
105
111
  getRemoteCustomDomain(designSystemId: string): Promise<CustomDomainRemoteModel>;