@supernova-studio/supernova-sdk-beta 2.2.6 → 2.2.7

package/build/sdk-typescript/src/core/SDKSupernova.d.ts

@@ -13,6 +13,7 @@ import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
 import { AreaMe } from "./areas/SDKAreaMe";
 import { AreaMultiplayer } from "./areas/SDKAreaMultiplayer";
 import { AreaNetwork } from "./areas/SDKAreaNetwork";
+import { AreaProjects } from "./areas/SDKAreaProjects";
 import { AreaRawData } from "./areas/SDKAreaRawData";
 import { AreaResources } from "./areas/SDKAreaResources";
 import { AreaStorage } from "./areas/SDKAreaStorage";
@@ -74,6 +75,8 @@ export declare class Supernova {
     multiplayer: AreaMultiplayer;
     /** Get access to AI capabilities */
     ai: AreaAI;
+    /** Get access to projects */
+    projects: AreaProjects;
     /** Get access to raw data for local-only restoration of data */
     raw: AreaRawData;
     /**

package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts

@@ -7,6 +7,7 @@ import { DocsEntityGroupModel } from "../../model/docs/entities/SDKDocsEntityGro
 import { DocsEntityPageModel } from "../../model/docs/entities/SDKDocsEntityPage";
 import { DocsSection } from "../../model/docs/sections/SDKDocsSection";
 import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
+import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
 import { DocsPublishStatus } from "../../model/enums/SDKDocsPublishStatus";
 import { DocumentationEnvironment } from "../../model/enums/SDKDocumentationEnvironment";
 import { ExportBuild, ExportBuildStatus } from "../../model/exporters/exporter_builds/SDKExportBuild";
@@ -166,17 +167,15 @@ export declare class AreaDocumentation {
      * @returns nothing
      */
     ungroupDocumentationGroup(from: RemoteWorkspaceVersionIdentifier, payload: DTODeleteDocumentationGroupInput): Promise<void>;
-    /** Fetches object containing the structure of the docs - documentation pages and groups with metadata but without the page payloads
-     * Not implemented for now
-     * @param from - Remote version to fetch from
-     * @returnsDocumentationLegacy object
-     */
-    getDocumentationStructureFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
-    /** Fetches entire documentation documentation structure, including all pages and groups and their payloads
+    /** Fetches entire documentation including content in the legacy format
      * @param from - Remote version to fetch from
      * @returns All documentation items
      */
-    getDocumentationFromRoot(from: RemoteWorkspaceVersionIdentifier): Promise<DocumentationLegacyGroup>;
+    getFullDocumentationLegacyRepresentation(from: RemoteWorkspaceVersionIdentifier): Promise<{
+        rootGroup: DocumentationLegacyGroup;
+        allPages: Array<DocumentationLegacyPage>;
+        allGroups: Array<DocumentationLegacyGroup>;
+    }>;
     /** Get ID of the multiplayer room for a given documentation page
      * @param from - Remote version to fetch from
      * @param pageId - ID of the documentation page

package/build/sdk-typescript/src/core/areas/SDKAreaProjects.d.ts

@@ -0,0 +1,69 @@
+import { SDKProject } from "../../model/projects/SDKProject";
+import { SDKProjectContext, SDKProjectContextCreationModel } from "../../model/projects/SDKProjectContext";
+import { DataCore } from "../data/SDKDataCore";
+/**
+ * Manages project-related operations within a workspace using untyped data storage.
+ */
+export declare class AreaProjects {
+    /** Internal reference to DataCore for data operations */
+    private dataCore;
+    /** Key under which all projects are stored */
+    private readonly PROJECTS_KEY;
+    /** Key under which all project contexts are stored */
+    private readonly PROJECT_CONTEXTS_KEY;
+    constructor(dataCore: DataCore);
+    /**
+     * Fetches all projects for a given workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns A promise resolving to an array of SDKProject instances.
+     */
+    getAllProjects(workspaceId: string): Promise<SDKProject[]>;
+    /**
+     * Creates a new project in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param name - The name of the new project.
+     * @returns A promise resolving to the created SDKProject instance.
+     */
+    createProject(workspaceId: string, name: string, contextId: string): Promise<SDKProject>;
+    /**
+     * Updates an existing project in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param updatedProject - The updated SDKProject instance.
+     * @returns A promise that resolves when the update is complete.
+     * @throws Error if the project is not found.
+     */
+    updateProject(workspaceId: string, updatedProject: SDKProject): Promise<void>;
+    /**
+     * Deletes a project from the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param projectId - The ID of the project to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    deleteProject(workspaceId: string, projectId: string): Promise<void>;
+    /**
+     * Retrieves all project contexts in a workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns An array of SDKProjectContext instances.
+     */
+    getAllProjectContexts(workspaceId: string): Promise<SDKProjectContext[]>;
+    /**
+     * Creates a new project context.
+     * @param workspaceId - The ID of the workspace.
+     * @param creationModel - The properties for the new context.
+     * @returns The created SDKProjectContext instance.
+     */
+    createProjectContext(workspaceId: string, creationModel: SDKProjectContextCreationModel): Promise<SDKProjectContext>;
+    /**
+     * Updates an existing project context.
+     * @param workspaceId - The ID of the workspace.
+     * @param updatedContext - The updated context instance.
+     * @throws Error if the context is not found.
+     */
+    updateProjectContext(workspaceId: string, updatedContext: SDKProjectContext): Promise<void>;
+    /**
+     * Deletes a project context.
+     * @param workspaceId - The ID of the workspace.
+     * @param contextId - The ID of the context to delete.
+     */
+    deleteProjectContext(workspaceId: string, contextId: string): Promise<void>;
+}

package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts

@@ -1,3 +1,4 @@
+import { DTOWorkspaceUntypedDataListResponse, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
 import { Acl } from "../../model/acl/SDKAcl";
 import { UserRole } from "../../model/enums/SDKUserRole";
 import { Membership } from "../../model/membership/SDKMembership";
@@ -234,4 +235,38 @@ export declare class AreaWorkspaces {
      * @returns Nothing
      */
     deleteWorkspaceInvitation(workspaceId: string, invitationId: string): Promise<void>;
+    /**
+     * Lists all untyped data for a given workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns A promise that resolves to the list of untyped data.
+     */
+    listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
+    /**
+     * Creates new untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param data - The data to create. Must be a valid JSON object.
+     * @returns A promise that resolves to the created untyped data.
+     */
+    createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
+    /**
+     * Deletes all untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    deleteAllUntypedData(workspaceId: string): Promise<void>;
+    /**
+     * Updates specific untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param id - The ID of the untyped data to update.
+     * @param data - The updated data. Must be a valid JSON object.
+     * @returns A promise that resolves to the updated untyped data.
+     */
+    updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
+    /**
+     * Deletes specific untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param id - The ID of the untyped data to delete.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    deleteUntypedData(workspaceId: string, id: string): Promise<void>;
 }

package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts

@@ -1,6 +1,6 @@
-import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODataSourceStorybookCreatePayload, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOStorybookImportPayload, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
+import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODataSourceStorybookCreatePayload, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOStorybookImportPayload, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTOWorkspaceUntypedDataListResponse, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
 import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
-import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
+import { DesignSystemAccessMode, DocsBlockDefinition, DocumentationLegacyGroup, DocumentationLegacyPage, ExportBuildStatus, ExporterJobDestination, ResourceFont, TokenThemeOverrideTranserObject, UserRole } from "../../exports";
 import { Acl } from "../../model/acl/SDKAcl";
 import { Asset } from "../../model/assets/SDKAsset";
 import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
@@ -264,6 +264,12 @@ export declare class DataCore {
     restoreDocumentationGroup(designSystemId: string, versionId: string, payload: DTORestoreDocumentationGroupInput): Promise<void>;
     /** Restore a documentation page   */
     restoreDocumentationPage(designSystemId: string, versionId: string, payload: DTORestoreDocumentationPageInput): Promise<void>;
+    /** Fetches entire documentation including content in the legacy format */
+    getFullDocumentationLegacyRepresentation(designSystemId: string, versionId: string, workspaceId: string): Promise<{
+        rootGroup: DocumentationLegacyGroup;
+        allPages: Array<DocumentationLegacyPage>;
+        allGroups: Array<DocumentationLegacyGroup>;
+    }>;
     /** Create a custom property in remote */
     updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
     /** Delete a custom property in remote */
@@ -624,6 +630,40 @@ export declare class DataCore {
     readKeyValueStorageData(designSystemId: string, key: string): Promise<string | object | undefined>;
     setKeyValueStorageData(designSystemId: string, key: string, value: string | object): Promise<void>;
     unsetKeyValueStorageData(designSystemId: string, key: string): Promise<void>;
+    /**
+     * Lists all untyped data for a given workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns A promise that resolves to the list of untyped data.
+     */
+    listUntypedData(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
+    /**
+     * Creates new untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param data - The data to create.
+     * @returns A promise that resolves to the created untyped data.
+     */
+    createUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
+    /**
+     * Deletes all untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    deleteAllUntypedData(workspaceId: string): Promise<void>;
+    /**
+     * Updates specific untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param id - The ID of the untyped data to update.
+     * @param data - The updated data.
+     * @returns A promise that resolves to the updated untyped data.
+     */
+    updateUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
+    /**
+     * Deletes specific untyped data in the specified workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @param id - The ID of the untyped data to delete.
+     * @returns A promise that resolves when the operation is complete.
+     */
+    deleteUntypedData(workspaceId: string, id: string): Promise<void>;
     getPageRedirects(designSystemId: string): Promise<{
         path: string;
         id: string;

package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts

@@ -1,4 +1,5 @@
-import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection } from "@supernova-studio/client";
+import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemContactsResponse, DTODesignSystemMemberListResponse, DTODesignSystemVersionStats, DTODocumentationAnalyticsTimeFrame, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOFigmaNodeV2, DTOGetDocumentationPageAnchorsResponse, DTOPipeline, DTOTokenCollection, DTOWorkspaceUntypedDataListResponse } from "@supernova-studio/client";
+import { DocumentationLegacyGroupModel } from "../../../exports";
 import { AclRemoteModel } from "../../../model/acl/SDKAcl";
 import { BootstrapDataRemoteModel } from "../../../model/base/SDKBootstrapData";
 import { BrandRemoteModel } from "../../../model/base/SDKBrand";
@@ -148,6 +149,11 @@ export declare class DataCoreReadRequests {
     getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
     /** Remote: Get documentation metadata */
     getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationLegacyModel>;
+    /** Remote: Get documentation metadata */
+    getRemoteDocumentationFullLegacyModel(designSystemId: string, versionId: string): Promise<{
+        pages: Array<DocumentationLegacyPageModel>;
+        groups: Array<DocumentationLegacyGroupModel>;
+    }>;
     /** Remote: Get documentation elements diff */
     getRemoteDocumentationElementsDiff(designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<DTODesignElementsDataDiffResponse>;
     /** Remote: Get documentation metadata */
@@ -333,4 +339,10 @@ export declare class DataCoreReadRequests {
         designSystemId: string;
         pagePersistentId: string;
     }[]>;
+    /**
+     * Fetches all untyped data for a given workspace.
+     * @param workspaceId - The ID of the workspace.
+     * @returns A promise that resolves to the list of untyped data.
+     */
+    getRemoteUntypedDataList(workspaceId: string): Promise<DTOWorkspaceUntypedDataListResponse>;
 }

package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts

@@ -1,4 +1,4 @@
-import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
+import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOElementPropertyValuesEditActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2, DTOWorkspaceUntypedDataResponse } from "@supernova-studio/client";
 import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
 import { DesignSystemAccessMode, ExporterJobDestination, TokenThemeOverrideTranserObject, UserRole } from "../../../exports";
 import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
@@ -722,4 +722,8 @@ export declare class DataCoreWriteRequests {
     createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
     updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
     deletePageRedirect(designSystemId: string, redirectId: string): Promise<void>;
+    createRemoteUntypedData(workspaceId: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
+    deleteRemoteAllUntypedData(workspaceId: string): Promise<void>;
+    updateRemoteUntypedData(workspaceId: string, id: string, data: any): Promise<DTOWorkspaceUntypedDataResponse>;
+    deleteRemoteUntypedData(workspaceId: string, id: string): Promise<void>;
 }

package/build/sdk-typescript/src/model/projects/SDKProject.d.ts

@@ -0,0 +1,39 @@
+export type SDKProjectRemoteModel = {
+    id: string;
+    name: string;
+    createdAt: string;
+    contextId: string;
+};
+export type SDKProjectTransportModel = {
+    id: string;
+    name: string;
+    createdAt: string;
+    contextId: string;
+};
+export declare class SDKProject {
+    /** Unique identifier of the project */
+    id: string;
+    /** Name of the project */
+    name: string;
+    /** Date and time when the project was created */
+    createdAt: Date;
+    /** Unique identifier of the project context */
+    contextId: string;
+    constructor(model: SDKProjectRemoteModel);
+    /**
+     * Constructs a representation suitable for remote storage.
+     * @returns The remote model of the project.
+     */
+    toRemote(): SDKProjectRemoteModel;
+    /**
+     * Constructs a representation that can be serialized to JSON for transport.
+     * @returns The transport model of the project.
+     */
+    toTransport(): SDKProjectTransportModel;
+    /**
+     * Reconstructs an SDKProject instance from a transport model.
+     * @param model - The transport model to deserialize.
+     * @returns A new SDKProject instance.
+     */
+    static fromTransport(model: SDKProjectTransportModel): SDKProject;
+}

package/build/sdk-typescript/src/model/projects/SDKProjectContext.d.ts

@@ -0,0 +1,47 @@
+export type SDKProjectContextRemoteModel = {
+    id: string;
+    name: string;
+    description?: string;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry?: object;
+};
+export type SDKProjectContextTransportModel = {
+    id: string;
+    name: string;
+    description?: string;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry?: object;
+};
+export interface SDKProjectContextCreationModel {
+    name: string;
+    description?: string;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry?: object;
+}
+/**
+ * Represents a project context containing repository and technology information.
+ */
+export declare class SDKProjectContext {
+    id: string;
+    name: string;
+    description: string | undefined;
+    designSystemId: string;
+    dependencies: Array<string>;
+    npmProxyRegistry: object | undefined;
+    constructor(model: SDKProjectContextRemoteModel);
+    /**
+     * Converts the context to a remote model for storage.
+     */
+    toRemote(): SDKProjectContextRemoteModel;
+    /**
+     * Converts the context to a transport model for serialization.
+     */
+    toTransport(): SDKProjectContextTransportModel;
+    /**
+     * Creates an instance from a transport model.
+     */
+    static fromTransport(model: SDKProjectContextTransportModel): SDKProjectContext;
+}