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

package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts

@@ -1,4 +1,5 @@
 import { Supernova } from "../../core/SDKSupernova";
+import { DocumentationLegacyGroup } from "../../model/documentation/SDKDocumentationLegacyGroup";
 import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
 import { DocumentationLegacyPageBlock } from "../../model/documentation/SDKDocumentationLegacyPageBlock";
 import { DocumentationLegacyPageBlockAssets } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets";
@@ -11,7 +12,10 @@ import { DocumentationLegacyPageBlockEmbedGeneric } from "../../model/documentat
 import { DocumentationLegacyPageBlockEmbedLink } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedLink";
 import { DocumentationLegacyPageBlockEmbedStorybook } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedStorybook";
 import { DocumentationLegacyPageBlockEmbedYoutube } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockEmbedYoutube";
+import { DocumentationLegacyPageBlockFigmaComponentPropsTable } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockFigmaComponentPropsTable";
+import { DocumentationLegacyPageBlockFiles } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockFiles";
 import { DocumentationLegacyPageBlockFrames } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockFrames";
+import { DocumentationLegacyPageBlockGuidelines } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockGuidelines";
 import { DocumentationLegacyPageBlockHeading } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockHeading";
 import { DocumentationLegacyPageBlockImage } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockImage";
 import { DocumentationLegacyPageOrderedList } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockOrderedList";
@@ -28,28 +32,43 @@ import { DocumentationLegacyPageBlockTokenGroup } from "../../model/documentatio
 import { DocumentationLegacyPageBlockTokenList } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockTokenList";
 import { DocumentationLegacyPageUnorderedList } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockUnorderedList";
 import { MarkdownTransformType } from "./SDKToolsMarkdownTransform";
+export type MarkdownTransformConfiguration = {
+    insideTable: boolean;
+};
+export type MarkdownTransformBlockConfig = {
+    urlType?: "relative-to-markdown" | "deployed";
+    documentationData?: {
+        rootGroup: DocumentationLegacyGroup;
+        allPages: Array<DocumentationLegacyPage>;
+        allGroups: Array<DocumentationLegacyGroup>;
+    };
+};
 /** Markdown block transformer */
 export declare class MarkdownTransformBlock {
     private transformType;
     private utilTransformer;
+    private linkResolver;
     private instance;
     private designSystemId;
     private versionId;
     private workspaceId;
-    newlineSeparator: string;
-    constructor(type: MarkdownTransformType, instance: Supernova, designSystemId: string, workspaceId: string, versionId: string);
+    private config;
+    private documentationData;
+    constructor(type: MarkdownTransformType, instance: Supernova, designSystemId: string, workspaceId: string, versionId: string, config?: MarkdownTransformBlockConfig);
+    /** Initialize documentation representation and link resolver - should be called once before conversion */
+    initialize(): Promise<void>;
     /** Converts a single block - depending on the type - to a markdown definition of specific type */
-    convertBlockToMarkdown(block: DocumentationLegacyPageBlock, pageContext: DocumentationLegacyPage): Promise<string | null>;
-    convertHeadingBlock(block: DocumentationLegacyPageBlockHeading): string | null;
-    convertCalloutBlock(block: DocumentationLegacyPageBlockCallout): string | null;
-    convertQuoteBlock(block: DocumentationLegacyPageBlockQuote): string | null;
+    convertBlockToMarkdown(block: DocumentationLegacyPageBlock, pageContext: DocumentationLegacyPage, config?: MarkdownTransformConfiguration): Promise<string | null>;
+    convertHeadingBlock(block: DocumentationLegacyPageBlockHeading, pageContext: DocumentationLegacyPage): Promise<string | null>;
+    convertCalloutBlock(block: DocumentationLegacyPageBlockCallout, pageContext: DocumentationLegacyPage): Promise<string | null>;
+    convertQuoteBlock(block: DocumentationLegacyPageBlockQuote, pageContext: DocumentationLegacyPage): Promise<string | null>;
     convertDividerBlock(): string | null;
-    convertImageBlock(block: DocumentationLegacyPageBlockImage): string | null;
-    convertOrderedListBlock(block: DocumentationLegacyPageOrderedList): string | null;
-    convertUnorderedListBlock(block: DocumentationLegacyPageUnorderedList): string | null;
+    convertImageBlock(block: DocumentationLegacyPageBlockImage, insideTable?: boolean): string | null;
+    convertOrderedListBlock(block: DocumentationLegacyPageOrderedList, pageContext: DocumentationLegacyPage): Promise<string | null>;
+    convertUnorderedListBlock(block: DocumentationLegacyPageUnorderedList, pageContext: DocumentationLegacyPage): Promise<string | null>;
     convertLiveCodeBlock(block: DocumentationLegacyPageBlockRenderCode): string | null;
     convertCodeBlock(block: DocumentationLegacyPageBlockCode): string | null;
-    convertTextBlock(block: DocumentationLegacyPageBlockText): string | null;
+    convertTextBlock(block: DocumentationLegacyPageBlockText, pageContext: DocumentationLegacyPage): Promise<string | null>;
     convertGenericEmbedBlock(block: DocumentationLegacyPageBlockEmbedGeneric): string | null;
     convertStorybookEmbedBlock(block: DocumentationLegacyPageBlockEmbedStorybook): string | null;
     convertLinkBlock(block: DocumentationLegacyPageBlockEmbedLink): string | null;
@@ -72,4 +91,8 @@ export declare class MarkdownTransformBlock {
     convertColumnItemBlock(block: DocumentationLegacyPageBlockColumnItem, pageContext: DocumentationLegacyPage): Promise<string | null>;
     convertCustomBlock(): string | null;
     convertURLBlock(block: DocumentationLegacyPageBlockEmbedGeneric, userAction: string): string | null;
+    convertFilesBlock(block: DocumentationLegacyPageBlockFiles): Promise<string | null>;
+    convertFigmaComponentPropsTableBlock(block: DocumentationLegacyPageBlockFigmaComponentPropsTable): Promise<string | null>;
+    convertGuidelinesBlock(block: DocumentationLegacyPageBlockGuidelines, pageContext: DocumentationLegacyPage): Promise<string | null>;
+    convertFigmaComponentsBlock(): string;
 }

package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts

@@ -1,22 +1,27 @@
+import { DocumentationLegacyPage } from "../../model/documentation/SDKDocumentationLegacyPage";
 import { DocumentationLegacyRichText } from "../../model/documentation/SDKDocumentationLegacyRichText";
 import { DocumentationLegacyPageBlockText } from "../../model/documentation/blocks/SDKDocumentationLegacyPageBlockText";
 import { Token } from "../../model/tokens/SDKToken";
+import { MarkdownLinkResolver } from "./SDKToolsMarkdownLinkResolver";
 /** Markdown block transformer */
 export declare class MarkdownTransformUtil {
     private tokenTransformer;
-    constructor();
+    private linkResolver;
+    constructor(linkResolver?: MarkdownLinkResolver);
     /** Converts rich text block to markdown
      *
      * This is very naive implementation and will break in complicated cases, like double control characters of the same type next to each other
      * Must improve later with something more sophisticated, ideally tree builder with branched resolution.
      */
-    convertTextBlockToMarkdown(block: DocumentationLegacyPageBlockText): string | null;
+    convertTextBlockToMarkdown(block: DocumentationLegacyPageBlockText, pageContext?: DocumentationLegacyPage): Promise<string | null>;
     /** Converts rich text to markdown
      *
      * This is very naive implementation and will break in complicated cases, like double control characters of the same type next to each other
      * Must improve later with something more sophisticated, ideally tree builder with branched resolution.
      */
-    convertRichTextToMarkdown(richText: DocumentationLegacyRichText): string;
+    convertRichTextToMarkdown(richText: DocumentationLegacyRichText, pageContext?: DocumentationLegacyPage): Promise<string>;
     /** Convert token to markdown representation */
     convertTokenToMarkdown(token: Token): string;
+    /** Convert tokens to markdown table representation */
+    convertTokensToMarkdownTable(tokens: Array<Token>): string;
 }

package/build/sdk-typescript/src/utils/RawUtils.d.ts

@@ -1,23 +1,42 @@
-import { DTODesignSystem } from "@supernova-studio/client";
+import { DTODesignSystem, DTOForgeProjectMember, DTOForgeAgent, DTOForgeChatMessageListResponse, DTOForgeChatThreadListResponse, DTOPortalSettings, DTODesignSystemContactsResponse, DTOFeatureIteration, DTOFeatureArtifactListResponse, DTOForgeProjectFeature, DTOThreadMessageListResponse } from "@supernova-studio/client";
 import { Asset } from "../model/assets/SDKAsset";
 import { Brand, BrandRemoteModel } from "../model/base/SDKBrand";
 import { DesignSystem } from "../model/base/SDKDesignSystem";
+import { DesignSystemContactList } from "../model/base/SDKDesignSystemContactList";
 import { DesignSystemVersion, DesignSystemVersionRemoteModel } from "../model/base/SDKDesignSystemVersion";
 import { Component, ComponentRemoteModel } from "../model/components/SDKComponent";
-import { DesignComponentRemoteModel } from "../model/components/SDKDesignComponent";
+import { DesignComponent, DesignComponentRemoteModel } from "../model/components/SDKDesignComponent";
 import { ElementDataView, ElementDataViewRemoteModel } from "../model/elements/SDKElementDataView";
 import { ElementProperty, ElementPropertyRemoteModel } from "../model/elements/SDKElementProperty";
 import { ElementPropertyValue, ElementPropertyValueRemoteModel } from "../model/elements/values/SDKElementPropertyValue";
+import { ExportBuild, ExportBuildModel } from "../model/exporters/exporter_builds/SDKExportBuild";
 import { AssetGroup } from "../model/groups/SDKAssetGroup";
 import { ComponentGroup, ComponentGroupRemoteModel } from "../model/groups/SDKComponentGroup";
-import { DesignComponentGroupRemoteModel } from "../model/groups/SDKDesignComponentGroup";
+import { DesignComponentGroup, DesignComponentGroupRemoteModel } from "../model/groups/SDKDesignComponentGroup";
 import { TokenGroup, TokenGroupRemoteModel } from "../model/groups/SDKTokenGroup";
 import { Membership, MembershipRemoteModel } from "../model/membership/SDKMembership";
+import { ChatThread } from "../model/messaging/SDKChatThread";
+import { ChatThreadMessage } from "../model/messaging/SDKChatThreadMessage";
+import { ForgeAgent } from "../model/projects/SDKForgeAgent";
+import { ForgeProject, ForgeProjectRemoteModel } from "../model/projects/SDKForgeProject";
+import { ForgeProjectContext, ForgeProjectContextRemoteModel } from "../model/projects/SDKForgeProjectContext";
+import { ForgeProjectFeature } from "../model/projects/SDKForgeProjectFeature";
+import { ForgeProjectFeatureArtifactList } from "../model/projects/SDKForgeProjectFeatureArtifactList";
+import { ForgeProjectFeatureIteration } from "../model/projects/SDKForgeProjectFeatureIteration";
+import { ForgeProjectMembership } from "../model/projects/SDKForgeProjectMembership";
 import { ResourceFont, ResourceFontModel } from "../model/resources/SDKResourceFont";
+import { RemoteStorybookEntry, StorybookEntry } from "../model/storybook/SDKStorybookEntry";
 import { Source, SourceRemoteModel } from "../model/support/SDKSource";
+import { ThreadMessageList } from "../model/threads/SDKThreadMessageList";
 import { Token } from "../model/tokens/SDKToken";
 import { TokenRemoteModel } from "../model/tokens/remote/SDKRemoteTokenModel";
+import { TrailEvent, TrailEventListResponse } from "../model/trail-events/SDKTrailEvent";
 import { User, UserRemoteModel } from "../model/users/SDKUser";
+import { UserMembership, UserMembershipRemoteModel } from "../model/users/SDKUserMembership";
+import { WorkspaceIntegrations, WorkspaceIntegrationsRemoteModel } from "../model/workspaces/SDKWorkspaceIntegration";
+import { PortalSettings } from "../model/workspaces/SDKWorkspacePortalSettings";
+import { SubscriptionProductFeatures, SubscriptionProductFeaturesRemoteModel } from "../model/workspaces/SDKWorkspaceProductFeatures";
+import { WorkspaceSubscription, WorkspaceSubscriptionRemoteModel } from "../model/workspaces/SDKWorkspaceSubscription";
 export declare class RawUtils {
     /** Builds components from raw data */
     static buildComponentsFromRaw(rawData: Array<ComponentRemoteModel>, properties: Array<ElementProperty>, propertyValues: Array<ElementPropertyValue>): Array<Component>;
@@ -47,6 +66,8 @@ export declare class RawUtils {
     static buildFontResourcesFromRaw(rawData: Array<ResourceFontModel>): Array<ResourceFont>;
     /** Builds memberships */
     static buildMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
+    /** Builds workspace members */
+    static buildWorkspaceMembersFromRaw(rawData: Array<UserMembershipRemoteModel>): Array<UserMembership>;
     /** Builds design systems */
     static buildDesignSystemsFromRaw(rawData: Array<DTODesignSystem>): Array<DesignSystem>;
     /** Builds versions */
@@ -55,4 +76,33 @@ export declare class RawUtils {
     static buildBrandsFromRaw(rawData: Array<BrandRemoteModel>): Array<Brand>;
     /** Builds user */
     static buildUserFromRaw(rawData: UserRemoteModel): User;
+    /** Builds design components */
+    static buildDesignComponentsFromRaw(rawData: Array<DesignComponentRemoteModel>, sources: Array<Source>): Array<DesignComponent>;
+    /** Builds design component groups */
+    static buildDesignComponentGroupsFromRaw(rawData: Array<DesignComponentGroupRemoteModel>, designComponents: Array<DesignComponent>): Array<DesignComponentGroup>;
+    static buildStorybookEntriesFromRaw(rawData: Array<RemoteStorybookEntry>): Array<StorybookEntry>;
+    static buildDocumentationBuildsFromRaw(rawData: Array<ExportBuildModel>): Array<ExportBuild>;
+    static buildForgeProjectsFromRaw(rawData: Array<ForgeProjectRemoteModel>): Array<ForgeProject>;
+    static buildForgeProjectMembershipsFromRaw(rawData: Array<DTOForgeProjectMember>): Array<ForgeProjectMembership>;
+    static buildForgeProjectMembersFromRaw(rawData: Array<DTOForgeProjectMember>): Array<ForgeProjectMembership>;
+    static buildForgeAgentsFromRaw(data: DTOForgeAgent[]): ForgeAgent[];
+    /** Builds chat threads */
+    static buildChatThreadsFromRaw(rawData: DTOForgeChatThreadListResponse): Array<ChatThread>;
+    /** Builds chat thread messages */
+    static buildChatThreadMessagesFromRaw(rawData: DTOForgeChatMessageListResponse): Array<ChatThreadMessage>;
+    static buildPortalSettingsFromRaw(rawData: DTOPortalSettings): PortalSettings;
+    /** Builds user memberships */
+    static buildUserMembershipsFromRaw(rawData: Array<MembershipRemoteModel>): Array<Membership>;
+    /** Builds workspace subscription */
+    static buildWorkspaceSubscriptionFromRaw(rawData: WorkspaceSubscriptionRemoteModel): WorkspaceSubscription;
+    static buildWorkspaceIntegrationsFromRaw(rawData: WorkspaceIntegrationsRemoteModel): WorkspaceIntegrations;
+    static buildWorkspaceProductFeaturesFromRaw(rawData: SubscriptionProductFeaturesRemoteModel): SubscriptionProductFeatures;
+    static buildDesignSystemContacts(rawData: DTODesignSystemContactsResponse): DesignSystemContactList;
+    static buildThreadMessagesFromRaw(rawData: DTOThreadMessageListResponse): ThreadMessageList;
+    static buildForgeProjectFeatureIterationsFromRaw(rawData: Array<DTOFeatureIteration>): Array<ForgeProjectFeatureIteration>;
+    static buildForgeProjectFeatureArtifactsFromRaw(rawData: DTOFeatureArtifactListResponse): ForgeProjectFeatureArtifactList;
+    static buildForgeProjectFeaturesFromRaw(rawData: DTOForgeProjectFeature[]): ForgeProjectFeature[];
+    static buildForgeProjectContextsFromRaw(rawData: Array<ForgeProjectContextRemoteModel>): Array<ForgeProjectContext>;
+    static buildForgeProjectTrailEventsFromRaw(rawData: TrailEventListResponse): Array<TrailEvent>;
+    static buildForgeProjectFromRaw(rawData: ForgeProjectRemoteModel): ForgeProject;
 }