npm - @supernova-studio/supernova-sdk-beta - Versions diffs - 2.0.31 → 2.0.36 - Mend

@supernova-studio/supernova-sdk-beta 2.0.31 → 2.0.36

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 (63) hide show

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

@@ -1,6 +1,6 @@
-import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
+import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignSystem, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOElementActionInput, DTOExporterPropertyValueMap, DTOFigmaNode, DTOFigmaNodeRenderIdInput, DTOFigmaNodeRenderInput, DTOFigmaNodeV2, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPageRedirectCreateBody, DTOPageRedirectUpdateBody, DTOPipelineCreateBody, DTOPipelineUpdateBody, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
 import { DesignSystemInvite, DesignSystemInviteUpdate, DesignSystemMemberUpdate, DesignSystemPendingMemberInvite, DesignSystemUserInvitation } from "@supernova-studio/model";
-import { DesignSystemAccessMode, TokenThemeOverrideTranserObject, UserRole } from "../../../exports";
+import { DesignSystemAccessMode, ExporterJobDestination, TokenThemeOverrideTranserObject, UserRole } from "../../../exports";
 import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
 import { DesignSystem, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
 import { DesignSystemVersionCreateRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
@@ -12,7 +12,6 @@ import { ConnectionProviders } from "../../../model/enums/SDKConnectionProviders
 import { DocumentationEnvironment } from "../../../model/enums/SDKDocumentationEnvironment";
 import { AuthenticationTokenPayload, AzurePersonalAccessTokenConnectionPayload, CreateAuthenticationTokenPayload, PersonalAccessTokenConnectionPayload } from "../../../model/exporters/SDKConnections";
 import { ExporterProvider, NewExporterPayload } from "../../../model/exporters/SDKExporter";
-import { NewPipelinePayload, PipelineUpdateModel } from "../../../model/exporters/SDKPipeline";
 import { ExportBuildModel } from "../../../model/exporters/exporter_builds/SDKExportBuild";
 import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemoteConnectionsModel";
 import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
@@ -38,6 +37,7 @@ import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorksp
 import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
 import { WorkspaceSubscriptionUpdateModel } from "../../../model/workspaces/SDKWorkspaceSubscription";
 import { DataBridge } from "../SDKDataBridge";
+import { DocumentationPageContent } from "../../areas/SDKAreaImport";
 export declare class DataCoreWriteRequests {
     private bridge;
     constructor(bridge: DataBridge);
@@ -140,7 +140,7 @@ export declare class DataCoreWriteRequests {
     updateRemoteDesignSystemMemberList(designSystemId: string, usersToInvite?: Array<DesignSystemUserInvitation>, invitesToInvite?: Array<DesignSystemPendingMemberInvite>, emailsToInvite?: Array<DesignSystemInvite>, invitesToUpdate?: Array<DesignSystemInviteUpdate>, deleteInvitationIds?: Array<string>, usersToUpdate?: Array<DesignSystemMemberUpdate>, removeUserIds?: Array<string>): Promise<void>;
     /** Remote: Deletes a design system */
     deleteDesignSystem(designSystemId: string): Promise<void>;
-    private elementAction;
+    elementAction(designSystemId: string, versionId: string, data: DTOElementActionInput): Promise<any>;
     createRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOCreateDocumentationPageInputV2): Promise<any>;
     updateApprovalState(designSystemId: string, versionId: string, data: DTODocumentationPageApprovalStateChangeInput): Promise<any>;
     /** Remote: create a group within documentation */
@@ -170,7 +170,9 @@ export declare class DataCoreWriteRequests {
     publishDocumentation(workspaceId: string, designSystemId: string, versionId: string, environment: DocumentationEnvironment): Promise<ExportBuildModel>;
     publishDocumentationDrafts(designSystemId: string, versionId: string, environment: DocumentationEnvironment, changes: DTOPublishDocumentationRequest["changes"]): Promise<ExportBuildModel>;
     /** Remote: Render specific figma frames */
-    renderFigmaFrames(designSystemId: string, versionId: string, data: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNode>>;
+    renderFigmaFrames(designSystemId: string, versionId: string, data: Array<DTOFigmaNodeRenderIdInput>): Promise<Array<DTOFigmaNode>>;
+    /** Remote: Render specific figma frames async */
+    renderFigmaFramesAsync(designSystemId: string, versionId: string, data: Array<DTOFigmaNodeRenderInput>): Promise<Array<DTOFigmaNodeV2>>;
     createRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
     updateRemoteToken(designSystemId: string, versionId: string, token: TokenRemoteModel): Promise<TokenRemoteModel>;
     createRemoteTokenGroup(designSystemId: string, versionId: string, group: TokenGroupRemoteModel): Promise<TokenGroupRemoteModel>;
@@ -231,11 +233,409 @@ export declare class DataCoreWriteRequests {
     /** Remote: Delete a workspace integration */
     deleteRemoteWorkspaceIntegration(workspaceId: string, integrationId: string): Promise<WorkspaceIntegrationType>;
     /** Remote: Create pipeline */
-    createRemotePipeline(workspaceId: string, pipeline: NewPipelinePayload): Promise<any>;
-    /** Remote: Create pipeline */
-    updateRemotePipeline(workspaceId: string, pipeline: PipelineUpdateModel): Promise<any>;
+    createRemotePipeline(workspaceId: string, payload: DTOPipelineCreateBody): Promise<{
+        id: string;
+        name: string;
+        workspaceId: string;
+        designSystemId: string;
+        exporterId: string;
+        isEnabled: boolean;
+        eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
+        latestJobs: {
+            status: "Success" | "InProgress" | "Failed" | "Timeout";
+            id: string;
+            createdAt: Date;
+            designSystem: {
+                id: string;
+                meta: {
+                    name: string;
+                    description?: string | undefined;
+                };
+            };
+            exporterId: string;
+            destinations: {
+                s3?: {} | undefined;
+                azure?: {
+                    branch: string;
+                    organizationId: string;
+                    projectId: string;
+                    repositoryId: string;
+                    url?: string | undefined;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                bitbucket?: {
+                    branch: string;
+                    workspaceSlug: string;
+                    projectKey: string;
+                    repoSlug: string;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                github?: {
+                    url: string;
+                    branch: string;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                gitlab?: {
+                    branch: string;
+                    projectId: string;
+                    url?: string | undefined;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                documentation?: {
+                    environment: "Live" | "Preview";
+                    changes?: {
+                        pagePersistentIds: string[];
+                        groupPersistentIds: string[];
+                    } | undefined;
+                } | undefined;
+                webhookUrl?: string | undefined;
+            };
+            designSystemVersion: {
+                id: string;
+                meta: {
+                    name: string;
+                    description?: string | undefined;
+                };
+                version: string;
+                isReadonly: boolean;
+            };
+            brandPersistentId?: string | undefined;
+            themePersistentId?: string | undefined;
+            themePersistentIds?: string[] | undefined;
+            exporterPropertyValues?: Record<string, string | number | boolean | string[] | Record<string, string>> | undefined;
+            finishedAt?: Date | undefined;
+            index?: number | undefined;
+            estimatedExecutionTime?: number | undefined;
+            createdBy?: {
+                userId: string;
+                userName: string;
+            } | undefined;
+            scheduleId?: string | undefined;
+            result?: {
+                s3?: {
+                    path: string;
+                    files: string[];
+                    bucket: string;
+                    url?: string | undefined;
+                    urlPrefix?: string | undefined;
+                    urls?: string[] | undefined;
+                } | undefined;
+                azure?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                bitbucket?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                github?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                gitlab?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                documentation?: {
+                    url: string;
+                } | undefined;
+                error?: string | undefined;
+                logs?: {
+                    message: string;
+                    type: "error" | "info" | "user" | "success" | "warning";
+                    time: Date;
+                    id?: string | undefined;
+                }[] | undefined;
+            } | undefined;
+        }[];
+        isExporterDeprecated: boolean;
+        brandPersistentId?: string | undefined;
+        themePersistentId?: string | undefined;
+        themePersistentIds?: string[] | undefined;
+        exporterPropertyValues?: Record<string, string | number | boolean | string[] | Record<string, string>> | undefined;
+        webhookUrl?: string | undefined;
+        destinationSnDocs?: {
+            environment: "Live" | "Preview";
+            changes?: {
+                pagePersistentIds: string[];
+                groupPersistentIds: string[];
+            } | undefined;
+        } | undefined;
+        destinationS3?: {} | undefined;
+        destinationGithub?: {
+            url: string;
+            branch: string;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+        destinationAzure?: {
+            branch: string;
+            organizationId: string;
+            projectId: string;
+            repositoryId: string;
+            url?: string | undefined;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+        destinationGitlab?: {
+            branch: string;
+            projectId: string;
+            url?: string | undefined;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+        destinationBitbucket?: {
+            branch: string;
+            workspaceSlug: string;
+            projectKey: string;
+            repoSlug: string;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+    }>;
+    /** Remote: Update pipeline */
+    updateRemotePipeline(designSystemId: string, pipelineId: string, payload: DTOPipelineUpdateBody): Promise<{
+        id: string;
+        name: string;
+        workspaceId: string;
+        designSystemId: string;
+        exporterId: string;
+        isEnabled: boolean;
+        eventType: "None" | "OnVersionReleased" | "OnHeadChanged" | "OnSourceUpdated";
+        latestJobs: {
+            status: "Success" | "InProgress" | "Failed" | "Timeout";
+            id: string;
+            createdAt: Date;
+            designSystem: {
+                id: string;
+                meta: {
+                    name: string;
+                    description?: string | undefined;
+                };
+            };
+            exporterId: string;
+            destinations: {
+                s3?: {} | undefined;
+                azure?: {
+                    branch: string;
+                    organizationId: string;
+                    projectId: string;
+                    repositoryId: string;
+                    url?: string | undefined;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                bitbucket?: {
+                    branch: string;
+                    workspaceSlug: string;
+                    projectKey: string;
+                    repoSlug: string;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                github?: {
+                    url: string;
+                    branch: string;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                gitlab?: {
+                    branch: string;
+                    projectId: string;
+                    url?: string | undefined;
+                    userId?: number | undefined;
+                    credentialId?: string | undefined;
+                    relativePath?: string | undefined;
+                    purgeDirectory?: boolean | undefined;
+                    commitAuthorName?: string | undefined;
+                    commitAuthorEmail?: string | undefined;
+                    connectionId?: string | undefined;
+                } | undefined;
+                documentation?: {
+                    environment: "Live" | "Preview";
+                    changes?: {
+                        pagePersistentIds: string[];
+                        groupPersistentIds: string[];
+                    } | undefined;
+                } | undefined;
+                webhookUrl?: string | undefined;
+            };
+            designSystemVersion: {
+                id: string;
+                meta: {
+                    name: string;
+                    description?: string | undefined;
+                };
+                version: string;
+                isReadonly: boolean;
+            };
+            brandPersistentId?: string | undefined;
+            themePersistentId?: string | undefined;
+            themePersistentIds?: string[] | undefined;
+            exporterPropertyValues?: Record<string, string | number | boolean | string[] | Record<string, string>> | undefined;
+            finishedAt?: Date | undefined;
+            index?: number | undefined;
+            estimatedExecutionTime?: number | undefined;
+            createdBy?: {
+                userId: string;
+                userName: string;
+            } | undefined;
+            scheduleId?: string | undefined;
+            result?: {
+                s3?: {
+                    path: string;
+                    files: string[];
+                    bucket: string;
+                    url?: string | undefined;
+                    urlPrefix?: string | undefined;
+                    urls?: string[] | undefined;
+                } | undefined;
+                azure?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                bitbucket?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                github?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                gitlab?: {
+                    pullRequestUrl: string;
+                } | undefined;
+                documentation?: {
+                    url: string;
+                } | undefined;
+                error?: string | undefined;
+                logs?: {
+                    message: string;
+                    type: "error" | "info" | "user" | "success" | "warning";
+                    time: Date;
+                    id?: string | undefined;
+                }[] | undefined;
+            } | undefined;
+        }[];
+        isExporterDeprecated: boolean;
+        brandPersistentId?: string | undefined;
+        themePersistentId?: string | undefined;
+        themePersistentIds?: string[] | undefined;
+        exporterPropertyValues?: Record<string, string | number | boolean | string[] | Record<string, string>> | undefined;
+        webhookUrl?: string | undefined;
+        destinationSnDocs?: {
+            environment: "Live" | "Preview";
+            changes?: {
+                pagePersistentIds: string[];
+                groupPersistentIds: string[];
+            } | undefined;
+        } | undefined;
+        destinationS3?: {} | undefined;
+        destinationGithub?: {
+            url: string;
+            branch: string;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+        destinationAzure?: {
+            branch: string;
+            organizationId: string;
+            projectId: string;
+            repositoryId: string;
+            url?: string | undefined;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+        destinationGitlab?: {
+            branch: string;
+            projectId: string;
+            url?: string | undefined;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+        destinationBitbucket?: {
+            branch: string;
+            workspaceSlug: string;
+            projectKey: string;
+            repoSlug: string;
+            userId?: number | undefined;
+            credentialId?: string | undefined;
+            relativePath?: string | undefined;
+            purgeDirectory?: boolean | undefined;
+            commitAuthorName?: string | undefined;
+            commitAuthorEmail?: string | undefined;
+            connectionId?: string | undefined;
+        } | undefined;
+    }>;
     /** Remote: Run pipeline */
-    runRemotePipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<any>;
+    runRemotePipeline(workspaceId: string, designSystemVersionId: string, pipelineId: string): Promise<ExportBuildModel>;
     /** Remote: Delete pipeline */
     deleteRemotePipeline(workspaceId: string, pipelineId: string): Promise<void>;
     /** Remote: Create exporter */
@@ -248,6 +648,8 @@ export declare class DataCoreWriteRequests {
     updateRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string, propertyValue: any): Promise<any>;
     /** Remote: Deletes an exporter configuration property value */
     deleteRemoteExporterConfigurationPropertyValue(designSystemId: string, exporterId: string, propertyKey: string): Promise<any>;
+    /** Remote: Create a new exporter build */
+    createExporterBuild(workspaceId: string, designSystemId: string, versionId: string, exporterId: string, destinations: ExporterJobDestination, brandId: string | undefined, themePersistentIds: Array<string> | undefined, exporterConfigurationProperties: DTOExporterPropertyValueMap | undefined): Promise<ExportBuildModel>;
     /** Remote: Schedules import job */
     scheduleImportJobForFigmaSources(designSystemId: string, versionId: string, sourceIds: Array<string>, dryRun: boolean): Promise<ImportJobRemoteModel>;
     /** Remote: Deletes a remote data source */
@@ -257,4 +659,9 @@ export declare class DataCoreWriteRequests {
     writeTokenStudioJSONData(designSystemId: string, versionId: string, data: object): Promise<object>;
     importTokens(designSystemId: string, brandId: string, sourceId: string, sourceName: string, sourceType: "FigmaVariablesPlugin", importType: "Upload", payload: any, isTokenTypeSplitEnabled?: boolean): Promise<ImportJobRemoteModel>;
     setKeyValueStorageData(designSystemId: string, kvData: object): Promise<void>;
+    createPageRedirect(designSystemId: string, body: DTOPageRedirectCreateBody): Promise<void>;
+    updatePageRedirect(designSystemId: string, redirectId: string, body: DTOPageRedirectUpdateBody): Promise<void>;
+    deletePageRedirect(designSystemId: string, redirectId: string): Promise<void>;
+    /** Remote: imports content into a documentation page */
+    importRemoteDocumentationPage(designSystemId: string, versionId: string, pageId: string, content: DocumentationPageContent): Promise<any>;
 }

package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts CHANGED Viewed

@@ -1,6 +1,11 @@
+import { DesignComponent } from "../../model/components/SDKDesignComponent";
 import { DesignComponentGroup, DesignComponentGroupRemoteModel } from "../../model/groups/SDKDesignComponentGroup";
 export declare class DesignComponentGroupResolver {
+    designComponents: Array<DesignComponent>;
+    constructor(designComponents: Array<DesignComponent>);
     resolveGroupData(data: Array<DesignComponentGroupRemoteModel>): Array<DesignComponentGroup>;
+    private assignSourceDataToGroups;
+    private propagateSourceDataToAncestors;
     private recomputePaths;
     private recomputePathsFromRoot;
     private reorderGroupsByRoots;