@supernova-studio/supernova-sdk-beta 2.0.19 → 2.0.20

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

@@ -1,5 +1,6 @@
 import { DTODocumentationLinkPreviewRequest, DTODocumentationPageApprovalStateChangeInput } from "@supernova-studio/client";
-import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
+import { DesignSystem, DesignSystemAccessMode, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
+import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
 import { CustomDomain } from "../../model/support/SDKCustomDomain";
 import { DataCore } from "../data/SDKDataCore";
 export declare class AreaDesignSystems {
@@ -21,11 +22,19 @@ export declare class AreaDesignSystems {
      * @returns custom domain information
      */
     designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
+    /** Fetches specific design system's memberships
+     * @param designSystemId - Design system's identifier
+     * @returns Design system's memberships
+     */
+    designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
     /** Creates a new design system and retrieves the newly created DS object
+     * @param workspaceId - Workspace to create the design system in
      * @param name - Name of the design system
+     * @param description - Description of the design system
+     * @param accessMode - Defines who can access the design system
      * @returns Newly created design system object
      */
-    createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
+    createDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode): Promise<DesignSystem>;
     getBlockDefinitions(designSystemId: string, versionId: string): Promise<import("../..").DocsBlockDefinition[]>;
     getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
         linkPreview: {
@@ -97,6 +106,13 @@ export declare class AreaDesignSystems {
      * @returns nothing
      */
     updateDesignSystemCustomDomain(designSystemId: string, newDomain: string): Promise<CustomDomain>;
+    /** Updates design system's member list
+     * @param designSystemId - ID of the design system
+     * @param inviteUserIds - User IDs to invite
+     * @param removeUserIds - User IDs to remove
+     * @returns nothing
+     */
+    updateDesignSystemMemberList(designSystemId: string, inviteUserIds: Array<string>, removeUserIds: Array<string>): Promise<void>;
     /** Deletes a design system. This action is irreversible, all data will be lost, and can only be performed by the admins of the workspace
      * @param designSystemId - ID of the design system
      * @returns Nothing. RIP design system.

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

@@ -213,7 +213,7 @@ export declare class AreaTokens {
     /** Warning: INTERNAL, DO NOT USE YET, NOT STABLE INTERFACE. Write theme in bulk */
     writeTheme(to: RemoteVersionIdentifier, theme: TokenTheme): Promise<void>;
     /** Resolves tokens by applying themes to them and retrieves new token set where values correctly correspond to that theme */
-    computeTokensByApplyingThemes(tokens: Array<Token>, themes: Array<TokenTheme>): Promise<Array<Token>>;
+    computeTokensByApplyingThemes(tokens: Array<Token>, themes: Array<TokenTheme>): Array<Token>;
     /** Separates groups by types */
     computeGroupTrees(groups: Array<TokenGroup>): Promise<Map<TokenType, Array<TokenGroup>>>;
     /** Get determistic mocked token data. Must be used with mocked token groups */

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

@@ -1,11 +1,12 @@
 import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTODocumentationPageAnchor, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, // TODO? DTODeleteDocumentationTabGroupInput,
 DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
-import { DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
+import { DesignSystemAccessMode, DocsBlockDefinition, ExportBuildStatus, ResourceFont, TokenThemeOverrideTranserObject } from "../../exports";
 import { Acl } from "../../model/acl/SDKAcl";
 import { Asset } from "../../model/assets/SDKAsset";
 import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
 import { Brand, BrandUpdateModel } from "../../model/base/SDKBrand";
 import { DesignSystem, DesignSystemSwitcher } from "../../model/base/SDKDesignSystem";
+import { DesignSystemMemberList } from "../../model/base/SDKDesignSystemMemberList";
 import { DesignSystemVersion, DesignSystemVersionCreate, DesignSystemVersionCreationJob, DesignSystemVersionUpdateModel } from "../../model/base/SDKDesignSystemVersion";
 import { DocumentationLegacy, DocumentationLegacyModel } from "../../model/base/SDKDocumentationLegacy";
 import { Component } from "../../model/components/SDKComponent";
@@ -185,6 +186,8 @@ export declare class DataCore {
     createDocumentationPage(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationPageInputV2, "persistentId">): Promise<string>;
     /** Update page approval state */
     updateApprovalState(designSystemId: string, versionId: string, payload: DTODocumentationPageApprovalStateChangeInput): Promise<string>;
+    /** Update design system's member list */
+    updateDesignSystemMemberList(designSystemId: string, inviteUserIds: Array<string>, removeUserIds: Array<string>): Promise<void>;
     /** Create a group within documentation */
     createDocumentationGroup(designSystemId: string, versionId: string, payload: Omit<DTOCreateDocumentationGroupInput, "persistentId">): Promise<string>;
     /** Create a tab group within documentation */
@@ -458,7 +461,7 @@ export declare class DataCore {
     /** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
     designSystems(workspaceId: any): Promise<Array<DesignSystem>>;
     /** Creates a design system */
-    createDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystem>;
+    createDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode): Promise<DesignSystem>;
     getBlockDefinitions(designSystemId: string, versionId: string): Promise<Array<DocsBlockDefinition>>;
     getUrlPreview(designSystemId: string, versionId: string, request: DTODocumentationLinkPreviewRequest): Promise<{
         linkPreview: {
@@ -498,8 +501,10 @@ export declare class DataCore {
     designSystemCustomDomain(designSystemId: string): Promise<CustomDomain>;
     /** Download information about a desing system source within a design system design and retrieve it resolved */
     designSystemSource(designSystemId: string, sourceId: string): Promise<Source>;
-    /** Download information about all desing system sources within a design system design and retrieve it resolved */
+    /** Download information about all design system sources within a design system design and retrieve it resolved */
     designSystemSources(designSystemId: string): Promise<Array<Source>>;
+    /** Download information about all design system members */
+    designSystemMemberList(designSystemId: string): Promise<DesignSystemMemberList>;
     getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructure>>;
     getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetail>;
     deleteFigmaSource(designSystemId: string, sourceId: string): Promise<void>;

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

@@ -1,7 +1,6 @@
-import { DTODesignElementsDataDiffResponse, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse, DTOPipeline } from "@supernova-studio/client";
+import { DTODesignElementsDataDiffResponse, DTODesignSystem, DTODesignSystemMemberListResponse, DTODocumentationLinkPreviewRequest, DTOFigmaNode, DTOGetDocumentationPageAnchorsResponse, DTOPipeline } from "@supernova-studio/client";
 import { AclRemoteModel } from "../../../model/acl/SDKAcl";
 import { BrandRemoteModel } from "../../../model/base/SDKBrand";
-import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
 import { DesignSystemVersionCreationJobRemoteModel, DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
 import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
 import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
@@ -104,9 +103,9 @@ export declare class DataCoreReadRequests {
     getRemoteWorkspaceSubscription(workspaceId: string): Promise<WorkspaceSubscriptionRemoteModel>;
     getRemoteWorkspaceAvailableProducts(workspaceId: string): Promise<Array<WorkspaceProductRemoteModel>>;
     /** Remote: Get information about one specific design system */
-    getRemoteDesignSystem(designSystemId: string): Promise<DesignSystemRemoteModel>;
+    getRemoteDesignSystem(designSystemId: string): Promise<DTODesignSystem>;
     /** Remote: Get information about all design systems under specific workspace */
-    getRemoteDesignSystems(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
+    getRemoteDesignSystems(workspaceId: string): Promise<Array<DTODesignSystem>>;
     /** Remote: Get custom domain */
     getRemoteCustomDomain(designSystemId: string): Promise<CustomDomainRemoteModel>;
     /** Remote: Get a single design source */
@@ -117,6 +116,8 @@ export declare class DataCoreReadRequests {
     getFigmaNodeStructures(designSystemId: string, versionId: string): Promise<Array<FigmaStructureModel>>;
     /** Remote: Get figma node detail */
     getFigmaNodeStructureDetail(designSystemId: string, versionId: string, figmaStructureId: string): Promise<FigmaStructureDetailModel>;
+    /** Remote: Get information about design system's members */
+    getRemoteDesignSystemMemberList(designSystemId: string): Promise<DTODesignSystemMemberListResponse>;
     /** Remote: Get design system documentation url */
     getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
     /** Remote: Get documentation metadata */

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

@@ -1,7 +1,7 @@
-import { DTOCreateDocumentationGroupInput, DTOCreateDocumentationPageInputV2, DTOCreateDocumentationTabInput, DTODeleteDocumentationGroupInput, DTODeleteDocumentationPageInputV2, DTODeleteDocumentationTabGroupInput, DTODocumentationPageApprovalStateChangeInput, DTODuplicateDocumentationGroupInput, DTODuplicateDocumentationPageInputV2, DTOFigmaNode, DTOFigmaNodeRenderInput, DTOMoveDocumentationGroupInput, DTOMoveDocumentationPageInputV2, DTOPublishDocumentationRequest, DTORestoreDocumentationGroupInput, DTORestoreDocumentationPageInput, DTOUpdateDocumentationGroupInput, DTOUpdateDocumentationPageInputV2 } from "@supernova-studio/client";
-import { TokenThemeOverrideTranserObject } from "../../../exports";
+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 { DesignSystemAccessMode, TokenThemeOverrideTranserObject } from "../../../exports";
 import { Brand, BrandRemoteModel, BrandUpdateModel } from "../../../model/base/SDKBrand";
-import { DesignSystem, DesignSystemRemoteModel, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
+import { DesignSystem, DesignSystemSwitcher } from "../../../model/base/SDKDesignSystem";
 import { DesignSystemVersionCreateRemoteModel, DesignSystemVersionUpdateModel } from "../../../model/base/SDKDesignSystemVersion";
 import { DocumentationLegacyModel } from "../../../model/base/SDKDocumentationLegacy";
 import { Component, ComponentRemoteModel, ComponentUpdateRemoteModel } from "../../../model/components/SDKComponent";
@@ -29,7 +29,7 @@ import { UserProfileUpdateModel } from "../../../model/users/SDKUserProfile";
 import { UserWorkspaceNotificationSettingsUpdateModel } from "../../../model/users/SDKUserWorkspaceNotificationSettings";
 import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
 import { WorkspaceIPWhitelistSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
-import { WorkspaceIntegrationType, WorkspaceIntegrationsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIntegration";
+import { WorkspaceIntegrationsRemoteModel, WorkspaceIntegrationType } from "../../../model/workspaces/SDKWorkspaceIntegration";
 import { WorkspaceIntegrationAccessTokenPayload } from "../../../model/workspaces/SDKWorkspaceIntegrationAccessToken";
 import { WorkspaceInvitationUpdateModel } from "../../../model/workspaces/SDKWorkspaceInvitation";
 import { WorkspaceNPMRegistrySettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
@@ -116,7 +116,7 @@ export declare class DataCoreWriteRequests {
     /** Remote: Restore the cancelled subscription */
     restoreRemoteWorkspaceSubscription(workspaceId: string): Promise<void>;
     /** Remote: Creates a new design system */
-    createRemoteDesignSystem(workspaceId: string, name: string, description?: string): Promise<DesignSystemRemoteModel>;
+    createRemoteDesignSystem(workspaceId: string, name: string, description?: string, accessMode?: DesignSystemAccessMode): Promise<DTODesignSystem>;
     /** Remote: Updates a design system metadata */
     updateRemoteDesignSystemMetadata(designSystemId: string, name: string, description?: string): Promise<void>;
     /** Remote: Updates a design system multibrand capabilities */
@@ -136,6 +136,8 @@ export declare class DataCoreWriteRequests {
     updateRemoteDesignSystemDocumentationSlug(designSystem: DesignSystem, docUserSlug: string): Promise<void>;
     /** Remote: Deletes a design system */
     deleteDesignSystem(designSystemId: string): Promise<void>;
+    /** Remote: Updates a design system's member list */
+    updateRemoteDesignSystemMemberList(designSystemId: string, inviteUserIds: Array<string>, removeUserIds: Array<string>): Promise<void>;
     private elementAction;
     createRemoteDocumentationPage(designSystemId: string, versionId: string, data: DTOCreateDocumentationPageInputV2): Promise<any>;
     updateApprovalState(designSystemId: string, versionId: string, data: DTODocumentationPageApprovalStateChangeInput): Promise<any>;

package/build/sdk-typescript/src/exports.d.ts

@@ -34,6 +34,7 @@ export type { FeaturePermissionResolution } from "./model/workspaces/SDKWorkspac
 export { Brand } from "./model/base/SDKBrand";
 export type { BrandUpdateModel } from "./model/base/SDKBrand";
 export { DesignSystem } from "./model/base/SDKDesignSystem";
+export type { DesignSystemAccessMode } from "./model/base/SDKDesignSystem";
 export { DesignSystemVersion } from "./model/base/SDKDesignSystemVersion";
 export type { DesignSystemVersionCreate, DesignSystemVersionUpdateModel, DesignSystemVersionCreationJob, } from "./model/base/SDKDesignSystemVersion";
 export { Membership } from "./model/membership/SDKMembership";

package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts

@@ -1,23 +1,9 @@
+import { DTODesignSystem } from "@supernova-studio/client";
 export type DesignSystemSwitcher = {
     isEnabled: boolean;
     designSystemIds: Array<string>;
 };
-export type DesignSystemRemoteModel = {
-    id: string;
-    meta: {
-        name: string;
-        description: string;
-    };
-    workspaceId: string;
-    isPublic: boolean;
-    isMultibrand: boolean;
-    isApprovalFeatureEnabled: boolean;
-    approvalRequiredForPublishing: boolean;
-    docSlug: string;
-    docUserSlug?: string;
-    docExporterId: string;
-    designSystemSwitcher: DesignSystemSwitcher;
-};
+export type DesignSystemAccessMode = "Open" | "InviteOnly";
 export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId">;
 export declare class DesignSystem {
     /** Unique identifier of design system */
@@ -44,9 +30,8 @@ export declare class DesignSystem {
     documentationUserSlug: string | null;
     /** Binding multiple design systems together */
     designSystemSwitcher: DesignSystemSwitcher;
-    constructor(model: DesignSystemRemoteModel);
-    /** Constructs representation that can be used to write full object to remote */
-    toRemote(): DesignSystemRemoteModel;
+    accessMode: DesignSystemAccessMode;
+    constructor(model: DTODesignSystem);
     /** Constructs representation that can be used to transport the instantiated object as JSON, for example for SSR <> Client use-cases. Reconstruct to class instance using `fromTransport` */
     toTransport(): DesignSystemTransportModel;
     /** Reconstructs class from the transport model */

package/build/sdk-typescript/src/model/base/SDKDesignSystemMemberList.d.ts

@@ -0,0 +1,9 @@
+import { DTODesignSystemMemberListResponse } from "@supernova-studio/client";
+export type DesignSystemMembership = {
+    userId: string;
+};
+export declare class DesignSystemMemberList {
+    /** List of members that belong to the design system */
+    members: Array<DesignSystemMembership>;
+    constructor(model: DTODesignSystemMemberListResponse);
+}

package/build/sdk-typescript/src/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts

@@ -3,10 +3,6 @@ import { TokenType } from "../../../enums/SDKTokenType";
 import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
 /** Token property - Additional non-value options */
 export type DocsBlockTokenPropertyOptions = {
-    /** Default theme to be chosen */
-    defaultTheme?: "none";
-    /** Default value preview */
-    defaultValuePreview?: "Split" | "Override";
     /** Token types that are allowed to be selected. All types allowed if nothing is provided */
     allowedTypes?: Array<TokenType>;
     /** How should the tokens be rendered in editor */
@@ -26,9 +22,20 @@ export type DocsBlockTokenPropertyData = DocsBlockPropertyData<Array<{
 }>> & {
     /** Selected token ids */
     selectedPropertyIds?: Array<string>;
-    /** Selected theme ids */
+    /** Swatches with selected theme ids */
+    swatches?: Array<{
+        id: string;
+        selectedThemeIds: Array<string>;
+    }>;
+    /**
+     * Selected theme ids
+     * @deprecated Swatches will be used instead
+     */
     selectedThemeIds?: Array<string>;
-    /** Display mode of themes associated with the token property */
+    /**
+     * Display mode of themes associated with the token property
+     * @deprecated Swatches will be used instead
+     */
     themeDisplayMode?: "Split" | "Override";
 };
 /** Token property - Definition model */

package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts

@@ -2,6 +2,7 @@ export declare enum UserRole {
     owner = "Owner",
     admin = "Admin",
     creator = "Creator",
+    contributor = "Contributor",
     billing = "Billing",
     viewer = "Viewer"
 }

package/build/sdk-typescript/src/model/exporters/SDKPipeline.d.ts

@@ -35,7 +35,7 @@ export type GitObjectQuery = {
 export type NewPipelinePayloadDestination = "Github" | "Gitlab" | "Bitbucket" | "Azure" | "WebhookUrl" | "S3" | "Documentation";
 export type NewPipelinePayload = {
     brandPersistentId?: string;
-    themePersistentId?: string;
+    themePersistentIds?: string[];
     designSystemId: string;
     destinations: {
         azure: AzureDestinationPayload | null;
@@ -97,7 +97,7 @@ export declare class Pipeline {
         };
     };
     brandPersistentId?: string;
-    themePersistentId?: string;
+    themePersistentIds?: string[];
     latestJobs: Array<ExportBuild>;
     constructor(data: DTOPipeline);
     get isBuildOnly(): boolean;

package/build/sdk-typescript/src/pulsar-interfaces.d.ts

@@ -32,7 +32,12 @@ export type PulsarContext = {
     dsId: string;
     versionId: string;
     brandId: string | null;
+    /**
+     * @deprecated
+     * Use themeIds instead
+     */
     themeId: string | null;
+    themeIds: string[] | null;
 };
 export interface PulsarBridgingInterface {
     export(fn: (sdk: Supernova, context: PulsarContext) => Promise<Array<AnyOutputFile>>): any;