@supernova-studio/supernova-sdk-beta 1.6.10 → 1.6.12

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

@@ -1,141 +1,216 @@
-import { Asset } from '../../model/assets/SDKAsset';
-import { RenderedAsset } from '../../model/assets/SDKRenderedAsset';
-import { AssetFormat } from '../../model/enums/SDKAssetFormat';
-import { AssetScale } from '../../model/enums/SDKAssetScale';
-import { DesignComponent } from '../../model/components/SDKDesignComponent';
-import { ExporterCustomBlock } from '../../model/exporters/custom_blocks/SDKExporterCustomBlock';
-import { DocumentationConfiguration } from '../../model/documentation/SDKDocumentationConfiguration';
-import { DocumentationItem } from '../../model/documentation/SDKDocumentationItem';
-import { AssetGroup } from '../../model/groups/SDKAssetGroup';
-import { DesignComponentGroup } from '../../model/groups/SDKDesignComponentGroup';
-import { TokenGroup, TokenGroupRemoteModel } from '../../model/groups/SDKTokenGroup';
-import { TokenRemoteModel } from '../../model/tokens/remote/SDKRemoteTokenModel';
-import { Token } from '../../model/tokens/SDKToken';
-import { DesignSystemVersion } from '../SDKDesignSystemVersion';
-import { Documentation } from '../SDKDocumentation';
-import { DataBridge } from './SDKDataBridge';
-import { ExporterConfigurationProperty } from '../../model/exporters/custom_properties/SDKExporterConfigurationProperty';
-import { DesignSystem } from '../SDKDesignSystem';
-import { ExporterCustomBlockVariant } from '../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant';
-import { Component } from '../../model/components/SDKComponent';
-import { TokenTheme, TokenThemeRemoteModel } from '../../model/themes/SDKTokenTheme';
-import { ElementDataView } from '../../model/elements/SDKElementDataView';
-import { ElementProperty } from '../..';
+import { Acl } from "../../model/acl/SDKAcl";
+import { Asset } from "../../model/assets/SDKAsset";
+import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
+import { Brand } from "../../model/base/SDKBrand";
+import { DesignSystem } from "../../model/base/SDKDesignSystem";
+import { DesignSystemVersion } from "../../model/base/SDKDesignSystemVersion";
+import { Documentation } from "../../model/base/SDKDocumentation";
+import { Component } from "../../model/components/SDKComponent";
+import { DesignComponent } from "../../model/components/SDKDesignComponent";
+import { DocumentationItem } from "../../model/documentation/SDKDocumentationItem";
+import { ElementDataView } from "../../model/elements/SDKElementDataView";
+import { ElementDataViewColumn } from "../../model/elements/SDKElementDataViewColumn";
+import { ElementProperty, ElementPropertyCreationModel, ElementPropertyTargetElementType, ElementPropertyUpdateModel } from "../../model/elements/SDKElementProperty";
+import { ElementPropertyValue } from "../../model/elements/values/SDKElementPropertyValue";
+import { TokenType } from "../../model/enums/SDKTokenType";
+import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
+import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
+import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
+import { Exporter } from "../../model/exporters/SDKExporter";
+import { AssetGroup } from "../../model/groups/SDKAssetGroup";
+import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
+import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
+import { TokenGroup } from "../../model/groups/SDKTokenGroup";
+import { Membership } from "../../model/membership/SDKMembership";
+import { Source } from "../../model/support/SDKSource";
+import { TokenTheme } from "../../model/themes/SDKTokenTheme";
+import { Token } from "../../model/tokens/SDKToken";
+import { User } from "../../model/users/SDKUser";
+import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
+import { Workspace } from "../../model/workspaces/SDKWorkspace";
+import { WorkspaceIPWhitelistSettings, WorkspaceIPWhitelistSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
+import { WorkspaceNPMRegistrySettings, WorkspaceNPMRegistrySettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
+import { WorkspaceOnboarding, WorkspaceOnboardingUpdateModel } from "../../model/workspaces/SDKWorkspaceOnboarding";
+import { SubscriptionProductFeatures } from "../../model/workspaces/SDKWorkspaceProductFeatures";
+import { WorkspaceProfileUpdateModel } from "../../model/workspaces/SDKWorkspaceProfile";
+import { WorkspaceSSOSettings, WorkspaceSSOSettingsUpdateModel } from "../../model/workspaces/SDKWorkspaceSSOSettings";
+import { TokenUpdateTransactionData } from "../areas/SDKAreaBulkOperations";
+import { RenderedAssetRequestSettings } from "./requests/SDKDataCoreRenderRequests";
+import { DataBridge } from "./SDKDataBridge";
 export declare class DataCore {
-    private tokensSynced;
-    private tokenGroupsSynced;
-    private themesSynced;
-    private componentsSynced;
-    private designComponentAssetSynced;
-    private designComponentAssetGroupsSynced;
-    private documentationItemsSynced;
-    private documentationSynced;
-    private exporterCustomBlocksSynced;
-    private elementPropertiesSynced;
-    private elementDataViewsSynced;
-    private tokens;
-    private tokenGroups;
-    private themes;
-    private components;
-    private designComponents;
-    private designComponentGroups;
-    private assets;
-    private assetGroups;
-    private documentation;
-    private documentationItems;
-    private exporterCustomBlocks;
-    private elementProperties;
-    private elementDataViews;
-    private bridge;
+    /** Read part of the network calls */
+    private read;
+    /** Write part of the network calls */
+    private write;
+    /** Asset generation part of the network calls */
+    private render;
     constructor(bridge: DataBridge);
-    /** Get workspace handle from server */
-    private currentWorkspaceHandle;
-    /** Get deisgn system documentation url from server */
-    private currentDeployedDocumentationUrl;
-    currentDesignSystemThemes(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<TokenTheme>>;
-    currentDesignSystemTokens(designSystemId: string, designSystemVersion: DesignSystemVersion, forceRefreshCache?: boolean): Promise<Array<Token>>;
-    currentDesignSystemTokenGroups(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<TokenGroup>>;
-    currentDesignSystemElementProperties(designSystemId: string, designSystemVersion: DesignSystemVersion, forceRefreshCache?: boolean): Promise<Array<ElementProperty>>;
-    currentDesignSystemElementDataViews(designSystemId: string, designSystemVersion: DesignSystemVersion, forceRefreshCache?: boolean): Promise<Array<ElementDataView>>;
-    currentDesignSystemAssets(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<Asset>>;
-    currentDesignSystemAssetGroups(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<AssetGroup>>;
-    renderAssetsForConfiguration(designSystemId: string, designSystemVersion: DesignSystemVersion, assets: Array<Asset>, groups: Array<AssetGroup>, format: AssetFormat, scale: AssetScale): Promise<Array<RenderedAsset>>;
-    assetPath(asset: Asset, parent: AssetGroup): string;
-    currentDesignSystemComponents(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<Component>>;
-    currentDesignSystemDesignComponents(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<DesignComponent>>;
-    currentDesignSystemDesignComponentGroups(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<DesignComponentGroup>>;
-    currentDesignSystemDocumentationItems(designSystem: DesignSystem, designSystemVersion: DesignSystemVersion): Promise<Array<DocumentationItem>>;
-    currentDesignSystemDocumentation(designSystem: DesignSystem, designSystemVersion: DesignSystemVersion): Promise<Documentation>;
-    currentExporterCustomBlocks(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<Array<ExporterCustomBlock>>;
-    currentExporterConfigurationProperties(workspaceId: string, designSystemId: string, exporterId: string, designSystemVersion: DesignSystemVersion): Promise<Array<ExporterConfigurationProperty>>;
-    currentExporterBlockVariants(workspaceId: string, designSystemId: string, exporterId: string, designSystemVersion: DesignSystemVersion): Promise<Array<ExporterCustomBlockVariant>>;
-    /** Update current element views of the documentation */
-    updateElementData(designSystem: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getElementData;
-    /** Prepare design configuration, merging it with pulsar data */
-    updateDocumentationData(designSystem: DesignSystem, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getDocumentation;
-    private getNPMRegistry;
-    /** Download all custom blocks provided by the currently active exporter */
-    updateExporterCustomBlocksData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getExporterCustomBlocks;
-    private getExporterCustomBlockData;
-    private resolveExporterCustomBlockData;
-    private getExporterConfigurationPropertyUserValues;
-    private getExporterConfigurationPropertiesUserValuesData;
-    private getExporter;
-    private getExporterData;
-    private resolveExporterData;
-    /** Prepare design system data for use for the entire design system, downloading and resolving all tokens */
-    updateTokenData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getTokens;
-    private getRawTokenData;
-    private resolveTokenData;
-    /** Prepare design system data for use for the entire design system, downloading and resolving all groups */
-    updateTokenGroupData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getTokenGroups;
-    private getRawTokenGroupData;
-    private resolveTokenGroupData;
-    /** Prepare design system data for use for the entire design system, downloading and resolving all tokens */
-    updateThemesData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getThemes;
-    private getRawThemeData;
-    private resolveThemeData;
-    /** Prepare design system data for use for the entire design system, downloading and resolving all components - and indirectly, assets as well */
-    updateComponentData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getComponents;
-    private getRawComponentData;
-    private getRawElementPropertyData;
-    private getRawElementPropertyValuesData;
-    private resolveComponentData;
-    /** Prepare design system data for use for the entire design system, downloading and resolving all design components - and indirectly, assets as well */
-    updateDesignComponentAndAssetData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getDesignComponentsAndAssets;
-    private getRawDesignComponentAndAssetData;
-    private resolveDesignComponentAndAssetData;
-    /** Prepare design system data for use for the entire design system, downloading and resolving all groups */
-    updateDesignComponentAndAssetGroupData(designSystemId: string, designSystemVersion: DesignSystemVersion): Promise<void>;
-    private getDesignComponentAndAssetGroups;
-    private getRawDesignComponentAndAssetGroupData;
-    private resolveDesignComponentGroupData;
-    private resolveAssetGroupData;
-    updateDocumentationItemData(designSystemId: string, designSystemVersion: DesignSystemVersion, blocks: Array<ExporterCustomBlock>, configuration: DocumentationConfiguration): Promise<void>;
-    private getDocumentationItems;
-    private getRawDocumentationItemData;
-    private resolveDocumentationItemData;
-    writeTokenData(designSystemId: string, designSystemVersion: DesignSystemVersion, tokens: Array<TokenRemoteModel>, groups: Array<TokenGroupRemoteModel>, deleteTokens: Array<Token>): Promise<{
-        tokens: Array<TokenRemoteModel>;
-        tokenGroups: Array<TokenGroup>;
+    /** Remote: Get information about currently logged in user */
+    currentUser(): Promise<User>;
+    /** Remote: Get information about a specific user */
+    user(userId: string): Promise<User>;
+    /** Remote: Get information about all workspaces user has access to, including which role they play */
+    memberships(userId: string): Promise<Array<Membership>>;
+    subscriptionProductFeatures(): Promise<SubscriptionProductFeatures>;
+    acls(): Promise<Acl>;
+    /** Deletes the user by id. Can only really delete its own user */
+    deleteUser(userId: string): Promise<void>;
+    /** Checks whether user can be deleted or not. Can only really check its own user */
+    canDeleteUser(userId: string): Promise<boolean>;
+    /** Logs out user. Can only really logout its own user */
+    logoutCurrentUser(): Promise<void>;
+    /** Updates the user profile of specified user. Can only really update its own user */
+    updateUserProfile(userId: string, profile: UserProfileUpdateModel): Promise<void>;
+    /** Updates the avatar of the current user */
+    updateUserAvatar(userId: string, avatar: File): Promise<void>;
+    /** Updates the avatar of the current user */
+    deleteUserAvatar(userId: string): Promise<void>;
+    /** Download all necessary data for element property definitions and retrieve them resolved */
+    elementPropertyDefinitions(designSystemId: string, versionId: string, type: ElementPropertyTargetElementType): Promise<Array<ElementProperty>>;
+    /** Download all necessary data for element property values and retrieve them resolved */
+    elementPropertyValues(designSystemId: string, versionId: string): Promise<Array<ElementPropertyValue>>;
+    /** Download all necessary data for element views and retrieve them resolved */
+    elementViews(designSystemId: string, versionId: string, type: ElementPropertyTargetElementType): Promise<Array<ElementDataView>>;
+    /** Download all necesssary data for tokens and retrieve them resolved */
+    tokens(designSystemId: string, versionId: string, filter?: {
+        type?: TokenType;
+        brandId?: string;
+    }): Promise<Array<Token>>;
+    /** Download all necesssary data for token usage and retrieve them resolved */
+    getTokenUsage(designSystemId: string, versionId: string, idInVersion: string): Promise<{
+        tokens: Array<string>;
+        components: Array<string>;
+        documentationPages: Array<string>;
     }>;
-    writeTokenThemeData(designSystemId: string, designSystemVersion: DesignSystemVersion, theme: TokenThemeRemoteModel): Promise<TokenThemeRemoteModel>;
-    documetationJobs(version: DesignSystemVersion, limit?: number): Promise<Array<{
-        status: 'InProgress' | 'Success' | 'Failed';
+    /** Write new token to remote */
+    createToken(designSystemId: string, versionId: string, token: Token, parentId: string): Promise<{
+        id: string;
+        idInVersion: string;
+    }>;
+    /** Update existing token in remote */
+    updateToken(designSystemId: string, versionId: string, token: Token): Promise<void>;
+    /** Write new token group to remote */
+    createTokenGroup(designSystemId: string, versionId: string, group: TokenGroup, parentId: string): Promise<{
+        id: string;
+        idInVersion: string;
+    }>;
+    /** Update existing token in remote */
+    updateTokenGroup(designSystemId: string, versionId: string, group: TokenGroup): Promise<void>;
+    /** Download all necessary data for token groups and retrieve them resolved */
+    tokenGroups(designSystemId: string, versionId: string, filter?: {
+        type?: TokenType;
+        brandId?: string;
+    }): Promise<Array<TokenGroup>>;
+    /** Write new token theme to remote */
+    createTokenTheme(designSystemId: string, versionId: string, theme: TokenTheme): Promise<{
+        id: string;
+        idInVersion: string;
+    }>;
+    /** Download all necessary data for token themes and retrieve them resolved */
+    themes(designSystemId: string, versionId: string): Promise<Array<TokenTheme>>;
+    /** Update existing token theme in remote */
+    updateTokenTheme(designSystemId: string, versionId: string, theme: TokenTheme): Promise<void>;
+    /** Write the tokens to remote */
+    writeTokenData(designSystemId: string, versionId: string, tokens: Array<Token>, groups: Array<TokenGroup>, deleteTokens: Array<Token>): Promise<void>;
+    writeTokenThemeData(designSystemId: string, versionId: string, theme: TokenTheme): Promise<void>;
+    /** Delete token from remote */
+    deleteToken(designSystemId: string, versionId: string, tokenId: string): Promise<void>;
+    /** Delete group from remote */
+    deleteTokenGroup(designSystemId: string, versionId: string, groupId: string): Promise<void>;
+    /** Update token property at remote */
+    updateTokenPropertyValue(designSystemId: string, versionId: string, newValue: string, token: Token, property: ElementProperty): Promise<void>;
+    /** Delete token property in remote */
+    deleteTokenPropertyValue(designSystemId: string, versionId: string, valueId: string): Promise<void>;
+    /** Create a custom property in remote */
+    createTokenProperty(designSystemId: string, versionId: string, model: ElementPropertyCreationModel): Promise<{
+        id: string;
+        idInVersion: string;
+    }>;
+    /** Create a custom property in remote */
+    updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: ElementPropertyUpdateModel): Promise<void>;
+    /** Delete a custom property in remote */
+    deleteTokenProperty(designSystemId: string, versionId: string, propertyId: string): Promise<void>;
+    /** Move column to a new index and reorder all other columns around it */
+    updateReorderTokenColumn(designSystemId: string, versionId: string, view: ElementDataView, column: ElementDataViewColumn, newIndex: number): Promise<void>;
+    /** Update column size */
+    updateResizeTokenColumn(designSystemId: string, versionId: string, view: ElementDataView, column: ElementDataViewColumn, newWidth: number): Promise<void>;
+    /** Delete theme from remote */
+    deleteTokenTheme(designSystemId: string, versionId: string, themeId: string): Promise<void>;
+    /** Download all necessary data for components and retrieve them resolved  */
+    components(designSystemId: string, versionId: string): Promise<Array<Component>>;
+    /** Download all necessary data for component groups and retrieve them resolved */
+    componentGroups(designSystemId: string, versionId: string): Promise<Array<ComponentGroup>>;
+    designComponents(designSystemId: string, versionId: string): Promise<Array<DesignComponent>>;
+    designComponentGroups(designSystemId: string, versionId: string): Promise<Array<DesignComponentGroup>>;
+    /** Download all necessary data for assets and retrieve them resolved */
+    assets(designSystemId: string, versionId: string): Promise<Array<Asset>>;
+    /** Download all necessary data for asset groups and retrieve them resolved */
+    assetGroups(designSystemId: string, versionId: string): Promise<Array<AssetGroup>>;
+    /** Render assets as PNG, SVG, PDF, or combinations of it */
+    renderedAssets(designSystemId: string, versionId: string, assets: Array<Asset>, groups: Array<AssetGroup>, settings: RenderedAssetRequestSettings): Promise<Array<RenderedAsset>>;
+    /** Retrieve the main documentation object through which all docs data can be accessed */
+    documentation(workspaceId: string, designSystemId: string, versionId: string): Promise<Documentation>;
+    /** Download all necessary data for documentation items (groups and pages) and retrieve them resolved */
+    documentationItems(workspaceId: string, designSystemId: string, versionId: string): Promise<Array<DocumentationItem>>;
+    /** Retrieve currently deployed documentation url */
+    documentationDomain(designSystemId: string, versionId: string): Promise<string | null>;
+    /** Publish the documentation */
+    documentationPublish(workspaceId: string, designSystemId: string, versionId: string): Promise<{
+        status: "Queued" | "InProgress" | "Failure";
+        jobId: string;
+        exporterId: string;
+    }>;
+    /** Download information about current exporter custom blocks and retrieve them resolved */
+    documentationExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlock>>;
+    /** Download information about current exporter custom block variants and retrieve them resolved */
+    documentationExporterCustomVariants(workspaceId: string, exporterId: string): Promise<Array<ExporterCustomBlockVariant>>;
+    /** Download information about user settings (definitions) of the exporter and retrieve it resolved */
+    exporterConfigurationProperties(exporterId: string, workspaceId: string, designSystemId: string): Promise<Array<ExporterConfigurationProperty>>;
+    /** Download information about user settings (values) of the exporter and retrieve it resolved */
+    exporterConfigurationPropertyValues(exporterId: string, designSystemId: string): Promise<Array<{
+        key: string;
+        value: any;
+    }>>;
+    /** Download information about installed exporter and retrieve it resolved */
+    exporter(workspaceId: string, exporterId: string): Promise<Exporter>;
+    /** Download information about all installed exporter and retrieve it resolved */
+    exporters(workspaceId: string): Promise<Array<Exporter>>;
+    /** Download information about documentation builds and retrieve it resolved */
+    documentationBuilds(workspaceId: string, designSystemId: string, versionId: string, limit?: number): Promise<Array<{
+        status: "InProgress" | "Success" | "Failed";
         id: string | null;
         exporterId: string | null;
     }>>;
-    publishDocumentation(version: DesignSystemVersion): Promise<{
-        status: 'Queued' | 'InProgress' | 'Failure';
-        jobId: string | null;
-        exporterId: string | null;
-    }>;
+    /** Download information about a single workspace and retrieve it resolved */
+    workspace(workspaceId: string): Promise<Workspace>;
+    createWorkspace(name: string, handle: string): Promise<Workspace>;
+    /** Validate that workspace handle is available */
+    validateIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
+    workspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboarding>;
+    workspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettings | null>;
+    workspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettings | null>;
+    workspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettings | null>;
+    updateWorkspaceProfile(workspaceId: string, profile: WorkspaceProfileUpdateModel): Promise<void>;
+    updateWorkspaceOnboarding(workspaceId: string, state: WorkspaceOnboardingUpdateModel): Promise<void>;
+    updateWorkspaceAvatar(workspaceId: string, avatar: File): Promise<void>;
+    updateWorkspaceSSOSettings(workspaceId: string, ssoSettings: WorkspaceSSOSettingsUpdateModel): Promise<void>;
+    updateWorkspaceIPWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<void>;
+    updateWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
+    deleteWorkspace(workspaceId: string): Promise<void>;
+    deleteWorkspaceAvatar(workspaceId: string): Promise<void>;
+    deleteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
+    /** Download information about a single design system and retrieve it resolved */
+    designSystem(designSystemId: string): Promise<DesignSystem>;
+    /** Download information about design systems that user has access to under a single workspace and retrieve it resolved */
+    designSystems(workspaceId: any): Promise<Array<DesignSystem>>;
+    /** 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 */
+    designSystemSources(designSystemId: string): Promise<Array<Source>>;
+    versions(designSystemId: string): Promise<Array<DesignSystemVersion>>;
+    version(designSystemId: string, versionId: string): Promise<DesignSystemVersion>;
+    getBrands(designSystemId: string, versionId: string): Promise<Array<Brand>>;
+    getBrand(designSystemId: string, versionId: string, brandId: string): Promise<Brand>;
+    getOAuthURL(service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<string>;
+    bulkUpdateTokenData(designSystemId: string, versionId: string, data: TokenUpdateTransactionData): Promise<any>;
 }

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

@@ -0,0 +1,124 @@
+import { AclRemoteModel } from "../../../model/acl/SDKAcl";
+import { BrandRemoteModel } from "../../../model/base/SDKBrand";
+import { DesignSystemRemoteModel } from "../../../model/base/SDKDesignSystem";
+import { DesignSystemVersionRemoteModel } from "../../../model/base/SDKDesignSystemVersion";
+import { DocumentationModel } from "../../../model/base/SDKDocumentation";
+import { ComponentRemoteModel } from "../../../model/components/SDKComponent";
+import { DesignComponentRemoteModel } from "../../../model/components/SDKDesignComponent";
+import { DocumentationGroupModel } from "../../../model/documentation/SDKDocumentationGroup";
+import { DocumentationPageModel } from "../../../model/documentation/SDKDocumentationPage";
+import { ElementDataViewRemoteModel } from "../../../model/elements/SDKElementDataView";
+import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
+import { ElementPropertyValueRemoteModel } from "../../../model/elements/values/SDKElementPropertyValue";
+import { TokenType } from "../../../model/enums/SDKTokenType";
+import { ExporterCustomBlockModel } from "../../../model/exporters/custom_blocks/SDKExporterCustomBlock";
+import { ExporterModel } from "../../../model/exporters/SDKExporter";
+import { ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
+import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesignComponentGroup";
+import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
+import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
+import { SourceRemoteModel } from "../../../model/support/SDKSource";
+import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
+import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
+import { UserRemoteModel } from "../../../model/users/SDKUser";
+import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
+import { WorkspaceIPWhitelistSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
+import { WorkspaceNPMRegistrySettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
+import { WorkspaceOnboardingRemoteModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
+import { SubscriptionProductFeaturesRemoteModel } from "../../../model/workspaces/SDKWorkspaceProductFeatures";
+import { WorkspaceSSOSettingsRemoteModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
+import { DataBridge } from "../SDKDataBridge";
+export declare class DataCoreReadRequests {
+    private bridge;
+    constructor(bridge: DataBridge);
+    /** Remote: Get information about currently logged in user */
+    getRemoteCurrentUser(): Promise<UserRemoteModel>;
+    /** Remote: Get information about a specific user */
+    getRemoteUser(userId: any): Promise<UserRemoteModel>;
+    /** Remote: Get information about all workspaces user has access to */
+    getRemoteMemberships(userId: string): Promise<Array<MembershipRemoteModel>>;
+    getRemoteSubscriptionProductFeatures(): Promise<SubscriptionProductFeaturesRemoteModel>;
+    getRemoteAcls(): Promise<AclRemoteModel>;
+    /** Remote: Get information about a specific workspace */
+    getRemoteWorkspaceDetail(workspaceId: string): Promise<WorkspaceRemoteModel>;
+    /** Remote: Validate can use workspace handle */
+    getRemoteIsWorkspaceHandleAvailable(handle: string): Promise<boolean>;
+    /** Remote: Get information about the state of workspace onboarding, what was completed and what not */
+    getRemoteWorkspaceOnboarding(workspaceId: string): Promise<WorkspaceOnboardingRemoteModel | null>;
+    /** Remote: Get information about the workspace IP whitelisting configuration */
+    getRemoteWorkspaceIPWhitelistSettings(workspaceId: string): Promise<WorkspaceIPWhitelistSettingsRemoteModel | null>;
+    getRemoteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<WorkspaceNPMRegistrySettingsRemoteModel | null>;
+    getRemoteWorkspaceSSOSettings(workspaceId: string): Promise<WorkspaceSSOSettingsRemoteModel | null>;
+    /** Remote: Get information about one specific design system */
+    getRemoteDesignSystem(designSystemId: string): Promise<DesignSystemRemoteModel>;
+    /** Remote: Get information about all design systems under specific workspace */
+    getRemoteDesignSystems(workspaceId: string): Promise<Array<DesignSystemRemoteModel>>;
+    /** Remote: Get a single design source */
+    getRemoteSource(designSystemId: string, sourceId: string): Promise<SourceRemoteModel>;
+    /** Remote: Get all design sources of a single design system */
+    getRemoteSources(designSystemId: string): Promise<Array<SourceRemoteModel>>;
+    /** Remote: Get design system documentation url */
+    getRemoteDocumentationUrl(designSystemId: string, versionId: string): Promise<string | null>;
+    /** Remote: Get documentation metadata */
+    getRemoteDocumentationStructure(designSystemId: string, versionId: string): Promise<DocumentationModel>;
+    /** Remote: Get content of the documentation - groups and pages */
+    getRemoteDocumentationItems(designSystemId: string, versionId: string): Promise<{
+        groups: Array<DocumentationGroupModel>;
+        pages: Array<DocumentationPageModel>;
+    }>;
+    /** Remote: Get custom blocks for currently installed documentation exporter under specific ds */
+    getRemoteExporterCustomBlocks(designSystemId: string, versionId: string): Promise<Array<ExporterCustomBlockModel>>;
+    /** Remote: Get user configuration of specific installed exporter */
+    getRemoteExporterConfigurationUserSpecifiedValues(designSystemId: string, exporterId: string): Promise<Array<{
+        key: string;
+        value: any;
+    }>>;
+    /** Remote: Get structural details and metadata about specific installed exporter */
+    getRemoteExporter(workspaceId: string, exporterId: string): Promise<ExporterModel>;
+    /** Remote: Get structural details and metadata about all exporters */
+    getRemoteExporters(workspaceId: string): Promise<Array<ExporterModel>>;
+    /** Remote: Get all tokens from all categories */
+    getRemoteTokens(designSystemId: string, versionId: string, filter?: {
+        type?: TokenType;
+        brandId?: string;
+    }): Promise<Array<TokenRemoteModel>>;
+    /** Remote: Get all token groups from all categories */
+    getRemoteTokenGroups(designSystemId: string, versionId: string, filter?: {
+        brandId?: string;
+    }): Promise<Array<TokenGroupRemoteModel>>;
+    /** Remote: Get all token themes from all categories */
+    getRemoteTokenThemes(designSystemId: string, versionId: string): Promise<Array<TokenThemeRemoteModel>>;
+    /** Remote: Get usage of the token across design system */
+    getRemoteTokenUsage(designSystemId: string, versionId: string, tokenId: string): Promise<{
+        tokens: Array<TokenRemoteModel>;
+        components: Array<DesignComponentRemoteModel>;
+        documentationPages: Array<DocumentationPageModel>;
+    }>;
+    /** Remote: Get all supernova-type components (note: Not design components, those have separate endpoints) */
+    getRemoteComponents(designSystemId: string, versionId: string): Promise<Array<ComponentRemoteModel>>;
+    /** Remote: Get all component groups */
+    getRemoteComponentGroups(designSystemId: string, versionId: string): Promise<Array<ComponentGroupRemoteModel>>;
+    /** Remote: Get design components (right now, those are only components coming from Figma) */
+    getRemoteDesignComponents(designSystemId: string, versionId: string): Promise<Array<DesignComponentRemoteModel>>;
+    /** Remote: Get design component groups (right now, those are only components coming from Figma) */
+    getRemoteDesignComponentGroups(designSystemId: string, versionId: string): Promise<Array<DesignComponentGroupRemoteModel>>;
+    /** Remote: Get assets (right now, those are only components coming from Figma, but this will change in the future) */
+    getRemoteAssets(designSystemId: string, versionId: string): Promise<Array<DesignComponentRemoteModel>>;
+    /** Remote: Get design component groups (right now, those are only components coming from Figma, but this will change in the future) */
+    getRemoteAssetGroups(designSystemId: string, versionId: string): Promise<Array<DesignComponentGroupRemoteModel>>;
+    getRemoteElementPropertyDefinitions(designSystemId: string, versionId: string): Promise<Array<ElementPropertyRemoteModel>>;
+    /** Remote: Get definitions of all element data views. This fetches element views for all types of elements, ie. tokens, components, assets etc. */
+    getRemoteElementDataViewDefinitions(designSystemId: string, versionId: string): Promise<Array<ElementDataViewRemoteModel>>;
+    /** Remote: Get all property values that were set by the user for each elemen */
+    getRemoteElementPropertyValues(designSystemId: string, versionId: string): Promise<ElementPropertyValueRemoteModel[]>;
+    getRemoteDocumentationBuilds(workspaceId: string, designSystemId: string, versionId: string, limit?: number): Promise<Array<{
+        status: "InProgress" | "Success" | "Failed";
+        id: string | null;
+        exporterId: string | null;
+    }>>;
+    getBrands(designSystemId: string, versionId: string): Promise<Array<BrandRemoteModel>>;
+    getBrand(designSystemId: string, versionId: string, brandId: string): Promise<BrandRemoteModel>;
+    getOAuthURL(service: "figma" | "bitbucket" | "github" | "gitlab" | "azure"): Promise<string>;
+    getVersion(designSystemId: string, versionId: string): Promise<DesignSystemVersionRemoteModel>;
+    getVersions(designSystemId: string): Promise<Array<DesignSystemVersionRemoteModel>>;
+}

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

@@ -0,0 +1,18 @@
+import { Asset } from "../../../model/assets/SDKAsset";
+import { RenderedAsset } from "../../../model/assets/SDKRenderedAsset";
+import { AssetFormat } from "../../../model/enums/SDKAssetFormat";
+import { AssetScale } from "../../../model/enums/SDKAssetScale";
+import { AssetGroup } from "../../../model/groups/SDKAssetGroup";
+import { DataBridge } from "../SDKDataBridge";
+export type RenderedAssetRequestSettings = Array<{
+    prefix: string;
+    suffix: string;
+    scale: AssetScale;
+    format: AssetFormat;
+}>;
+export declare class DataCoreRenderRequests {
+    private bridge;
+    constructor(bridge: DataBridge);
+    renderAssetsForConfiguration(designSystemId: string, versionId: string, settings: RenderedAssetRequestSettings, assets: Array<Asset>, groups: Array<AssetGroup>): Promise<Array<RenderedAsset>>;
+    private assetPath;
+}

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

@@ -0,0 +1,73 @@
+import { ElementDataViewColumnType } from "../../../exports";
+import { ElementPropertyRemoteModel } from "../../../model/elements/SDKElementProperty";
+import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
+import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
+import { TokenRemoteModel } from "../../../model/tokens/remote/SDKRemoteTokenModel";
+import { Token } from "../../../model/tokens/SDKToken";
+import { UserProfileUpdateModel } from "../../../model/users/SDKUserProfile";
+import { WorkspaceRemoteModel } from "../../../model/workspaces/SDKWorkspace";
+import { WorkspaceIPWhitelistSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceIPWhitelistSettings";
+import { WorkspaceNPMRegistrySettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceNPMRegistrySettings";
+import { WorkspaceOnboardingUpdateModel } from "../../../model/workspaces/SDKWorkspaceOnboarding";
+import { WorkspaceProfileUpdateModel } from "../../../model/workspaces/SDKWorkspaceProfile";
+import { WorkspaceSSOSettingsUpdateModel } from "../../../model/workspaces/SDKWorkspaceSSOSettings";
+import { DataBridge } from "../SDKDataBridge";
+export declare class DataCoreWriteRequests {
+    private bridge;
+    constructor(bridge: DataBridge);
+    /** Remote: Deletes the user by id. Can only really delete its own user */
+    deleteRemoteUser(userId: string): Promise<void>;
+    /** Remote: Checks whether user can be deleted or not. Can only really check its own user */
+    canDeleteRemoteUser(userId: string): Promise<boolean>;
+    /** Remote: Updates the user profile of specified user. Can only really update its own user */
+    updateRemoteUserProfile(profile: UserProfileUpdateModel, userId: string): Promise<void>;
+    /** Remote: Updates the avatar of the current user */
+    updateRemoteUserAvatar(userId: string, avatar: File): Promise<void>;
+    /** Remote: Updates the avatar of the current user */
+    deleteRemoteUserAvatar(userId: string): Promise<void>;
+    /** Remote: Logs out user. Can only really logout its own user */
+    logoutRemoteCurrentUser(): Promise<void>;
+    /** Remote: Creates a new workspace */
+    createRemoteWorkspace(name: string, handle: string): Promise<WorkspaceRemoteModel>;
+    /** Remote: Updates a workspace profile */
+    updateRemoteWorkspaceProfile(workspaceId: string, profile: WorkspaceProfileUpdateModel): Promise<void>;
+    /** Remote: Updates a workspace avatar */
+    updateRemoteWorkspaceAvatar(workspaceId: string, avatar: File): Promise<void>;
+    /** Remote: Updates a workspace onboarding */
+    updateRemoteWorkspaceOnboarding(workspaceId: string, onboarding: WorkspaceOnboardingUpdateModel): Promise<void>;
+    /** Remote: Updates a workspace SSO settings */
+    updateRemoteWorkspaceSSOSettings(workspaceId: string, ssoSettings: WorkspaceSSOSettingsUpdateModel): Promise<void>;
+    /** Remote: Updates a workspace IP whitelist settings */
+    updateRemoteWorkspaceIPWhitelistSettings(workspaceId: string, ipWhitelistSettings: WorkspaceIPWhitelistSettingsUpdateModel): Promise<void>;
+    /** Remote: Updates a workspace NPM registry settings */
+    updateRemoteWorkspaceNPMRegistrySettings(workspaceId: string, npmRegistrySettings: WorkspaceNPMRegistrySettingsUpdateModel): Promise<void>;
+    /** Remote: Deletes a workspace */
+    deleteRemoteWorkspace(workspaceId: string): Promise<void>;
+    /** Remote: Deletes a workspace avatar */
+    deleteRemoteWorkspaceAvatar(workspaceId: string): Promise<void>;
+    /** Remote: Deletes a workspace NPM settings */
+    deleteRemoteWorkspaceNPMRegistrySettings(workspaceId: string): Promise<void>;
+    publishDocumentation(workspaceId: string, designSystemId: string, versionId: string): Promise<{
+        status: "Queued" | "InProgress" | "Failure";
+        jobId: string;
+        exporterId: string;
+    }>;
+    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>;
+    updateRemoteTokenGroup(designSystemId: string, versionId: string, group: TokenGroupRemoteModel): Promise<void>;
+    deleteRemoteToken(designSystemId: string, versionId: string, tokenId: string): Promise<void>;
+    deleteRemoteTokenGroup(designSystemId: string, versionId: string, tokenGroupId: string): Promise<void>;
+    createRemoteTokenTheme(designSystemId: string, versionId: string, theme: TokenThemeRemoteModel): Promise<TokenThemeRemoteModel>;
+    updateRemoteTokenTheme(designSystemId: string, versionId: string, group: TokenThemeRemoteModel): Promise<void>;
+    deleteRemoteTokenTheme(designSystemId: string, versionId: string, themeId: string): Promise<void>;
+    writeTokenData(designSystemId: string, versionId: string, tokens: Array<TokenRemoteModel>, groups: Array<TokenGroupRemoteModel>, deleteTokens: Array<Token>): Promise<void>;
+    writeTokenThemeData(designSystemId: string, versionId: string, theme: TokenThemeRemoteModel): Promise<void>;
+    updateTokenPropertyValue(designSystemId: string, versionId: string, newValue: string, tokenId: string, propertyId: string): Promise<void>;
+    deleteTokenPropertyValue(designSystemId: string, versionId: string, valueId: string): Promise<void>;
+    createTokenProperty(designSystemId: string, versionId: string, model: object): Promise<ElementPropertyRemoteModel>;
+    updateTokenProperty(designSystemId: string, versionId: string, propertyIdInVersion: string, model: object): Promise<void>;
+    deleteTokenProperty(designSystemId: string, versionId: string, propertyId: string): Promise<void>;
+    updateReorderTokenColumn(designSystemId: string, versionId: string, viewId: string, columnId: string, newIndex: number): Promise<void>;
+    updateResizeTokenColumn(designSystemId: string, versionId: string, viewId: string, columnType: ElementDataViewColumnType, columnId: string, columnThemeId: string | undefined, columnBasePropertyType: string | undefined, newWidth: number): Promise<void>;
+}