@supernova-studio/supernova-sdk-beta 1.6.29 → 1.6.31

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

@@ -9,6 +9,7 @@ import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
 import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
 import { AreaMe } from "./areas/SDKAreaMe";
 import { AreaNetwork } from "./areas/SDKAreaNetwork";
+import { AreaResources } from "./areas/SDKAreaResources";
 import { AreaStorage } from "./areas/SDKAreaStorage";
 import { AreaTokens } from "./areas/SDKAreaTokens";
 import { AreaUsers } from "./areas/SDKAreaUsers";
@@ -36,6 +37,8 @@ export declare class Supernova {
     components: AreaComponents;
     /** Get, create, update, manipulate or delete assets */
     assets: AreaAssets;
+    /** Get, create, update, manipulate or delete resources */
+    resources: AreaResources;
     /** Get, create, update, manipulate or delete documentation items */
     documentation: AreaDocumentation;
     /** Get, create, update, manipulate or delete pipelines and automation jobs */

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

@@ -0,0 +1,24 @@
+import { ResourceAsset, ResourceFont } from "../../exports";
+import { DataCore } from "../data/SDKDataCore";
+import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
+export declare class AreaResources {
+    /** Internal: Engine */
+    private dataCore;
+    constructor(dataCore: DataCore);
+    /** Fetches all remote asset resources in the version
+     * @param from - Remote version to fetch from
+     * @returns All image resources in the specified version
+     */
+    getAssetResources(from: RemoteVersionIdentifier): Promise<Array<ResourceAsset>>;
+    /** Fetches all remote font resources in the version
+     * @param from - Remote version to fetch from
+     * @returns All font resources in the specified version
+     */
+    getFontResources(from: RemoteVersionIdentifier): Promise<Array<ResourceFont>>;
+    /** Uploads new asset resource */
+    uploadAssetResource(from: RemoteVersionIdentifier, asset: File): Promise<ResourceAsset>;
+    /** Uploads new font resource */
+    uploadFontResource(from: RemoteVersionIdentifier, font: File): Promise<ResourceFont>;
+    /** Deletes resource of any type */
+    deleteResource(from: RemoteVersionIdentifier, resourceId: string): Promise<void>;
+}

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

@@ -1,3 +1,4 @@
+import { ResourceFont } from "../../exports";
 import { Acl } from "../../model/acl/SDKAcl";
 import { Asset } from "../../model/assets/SDKAsset";
 import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
@@ -48,6 +49,7 @@ import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup
 import { TokenGroup } from "../../model/groups/SDKTokenGroup";
 import { ImportJob } from "../../model/jobs/SDKImportJob";
 import { Membership } from "../../model/membership/SDKMembership";
+import { ResourceAsset } from "../../model/resources/SDKResourceAsset";
 import { CustomDomain } from "../../model/support/SDKCustomDomain";
 import { FigmaStructure } from "../../model/support/SDKFigmaStructure";
 import { FigmaStructureDetail } from "../../model/support/SDKFigmaStructureDetail";
@@ -269,6 +271,16 @@ export declare class DataCore {
         jobId: string;
         exporterId: string;
     }>;
+    /** Retrieve all asset resources */
+    assetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAsset>>;
+    /** Retrieve all font resources */
+    fontResources(designSystemId: string, versionId: string): Promise<Array<ResourceFont>>;
+    /** Upload asset resource */
+    uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAsset>;
+    /** Upload font resource */
+    uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFont>;
+    /** Delete any resource */
+    deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
     pipelines(workspaceId: string, designSystemId?: string): Promise<Array<Pipeline>>;
     githubConnections(): Promise<Array<CodegenConnection>>;
     githubAccounts(githubConnectionId: string): Promise<Array<CodegenAccount>>;

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

@@ -37,6 +37,8 @@ import { DesignComponentGroupRemoteModel } from "../../../model/groups/SDKDesign
 import { TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
 import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
 import { MembershipRemoteModel } from "../../../model/membership/SDKMembership";
+import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
+import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
 import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
 import { FigmaStructureModel } from "../../../model/support/SDKFigmaStructure";
 import { FigmaStructureDetailModel } from "../../../model/support/SDKFigmaStructureDetail";
@@ -121,6 +123,10 @@ export declare class DataCoreReadRequests {
     getRemoteExporters(workspaceId: string, filter?: {
         installedOnly?: boolean;
     }): Promise<Array<ExporterModel>>;
+    /** Remote: Get all asset resources */
+    getRemoteAssetResources(designSystemId: string, versionId: string): Promise<Array<ResourceAssetModel>>;
+    /** Remote: Get all font resources */
+    getRemoteFontResources(designSystemId: string, versionId: string): Promise<Array<ResourceFontModel>>;
     /** Remote: Get all tokens from all categories */
     getRemoteTokens(designSystemId: string, versionId: string, filter?: {
         type?: TokenType;

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

@@ -16,6 +16,8 @@ import { ConnectionRemoteModel } from "../../../model/exporters/remote/SDKRemote
 import { ComponentGroup, ComponentGroupRemoteModel } from "../../../model/groups/SDKComponentGroup";
 import { TokenGroup, TokenGroupRemoteModel } from "../../../model/groups/SDKTokenGroup";
 import { ImportJobRemoteModel } from "../../../model/jobs/SDKImportJob";
+import { ResourceAssetModel } from "../../../model/resources/SDKResourceAsset";
+import { ResourceFontModel } from "../../../model/resources/SDKResourceFont";
 import { CustomDomainRemoteModel } from "../../../model/support/SDKCustomDomain";
 import { SourceRemoteModel } from "../../../model/support/SDKSource";
 import { TokenThemeRemoteModel } from "../../../model/themes/SDKTokenTheme";
@@ -193,6 +195,12 @@ export declare class DataCoreWriteRequests {
     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, columnPropertyDefinitionId: string | undefined, newWidth: number): Promise<void>;
+    /** Remote: Upload a new asset resource */
+    uploadAssetResource(designSystemId: string, versionId: string, asset: File): Promise<ResourceAssetModel>;
+    /** Remote: Upload a new font resource */
+    uploadFontResource(designSystemId: string, versionId: string, font: File): Promise<ResourceFontModel>;
+    /** Remote: Delete a resource */
+    deleteResource(designSystemId: string, versionId: string, resourceId: string): Promise<void>;
     createRemoteComponent(designSystemId: string, versionId: string, component: ComponentRemoteModel): Promise<ComponentRemoteModel>;
     updateRemoteComponent(designSystemId: string, versionId: string, component: ComponentUpdateRemoteModel): Promise<ComponentRemoteModel>;
     createRemoteComponentGroup(designSystemId: string, versionId: string, group: ComponentGroupRemoteModel): Promise<ComponentGroupRemoteModel>;

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

@@ -39,7 +39,7 @@ export type { ElementDataViewColumn } from "./model/elements/SDKElementDataViewC
 export type { DesignComponent } from "./model/components/SDKDesignComponent";
 export type { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
 export type { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
-export type { DocsBlockItem } from "./model/docs/blocks/definition/SDKDocsBlockItem";
+export type { DocsBlockItemDefinition } from "./model/docs/blocks/definition/SDKDocsBlockItemDefinition";
 export type { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayout";
 export type { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
 export type { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";

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

@@ -55,10 +55,11 @@ export { ElementDataViewColumn, ElementDataViewColumnBasePropertyType, ElementDa
 export { DesignComponent } from "./model/components/SDKDesignComponent";
 export { DocsBlockBehavior } from "./model/docs/blocks/definition/SDKDocsBlockBehavior";
 export { DocsBlockDefinition } from "./model/docs/blocks/definition/SDKDocsBlockDefinition";
-export { DocsBlockItem } from "./model/docs/blocks/definition/SDKDocsBlockItem";
+export { DocsBlockItemDefinition } from "./model/docs/blocks/definition/SDKDocsBlockItemDefinition";
 export { DocsBlockLayout } from "./model/docs/blocks/definition/SDKDocsBlockLayout";
 export { DocsBlockOnboarding } from "./model/docs/blocks/definition/SDKDocsBlockOnboarding";
 export { DocsBlockVariant } from "./model/docs/blocks/definition/SDKDocsBlockVariant";
+export { DocsBlockMode } from "./model/enums/SDKDocBlockMode";
 export { DocsEntity } from "./model/docs/entities/SDKDocsEntity";
 export { DocsEntityGroup } from "./model/docs/entities/SDKDocsEntityGroup";
 export { DocsEntityPage } from "./model/docs/entities/SDKDocsEntityPage";
@@ -95,6 +96,8 @@ export type { DocsBlockSingleSelectPropertyData, DocsBlockSingleSelectPropertyOp
 export { DocsBlockTablePropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
 export type { DocsBlockTablePropertyData, DocsBlockTablePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTableProperty";
 export { DocsBlockTextPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
+export type { DocsBlockUrlPropertyData, DocsBlockUrlPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockUrlProperty";
+export { DocsBlockUrlPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockUrlProperty";
 export type { DocsBlockTextPropertyData, DocsBlockTextPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTextProperty";
 export { DocsBlockTokenPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
 export type { DocsBlockTokenPropertyData, DocsBlockTokenPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenProperty";
@@ -104,6 +107,7 @@ export { DocsBlockTokenTypePropertyDefinition } from "./model/docs/blocks/proper
 export type { DocsBlockTokenTypePropertyData, DocsBlockTokenTypePropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty";
 export { DocsBlockDividerPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
 export type { DocsBlockDividerPropertyData, DocsBlockDividerPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockDividerProperty";
+export { DocsBlockStorybookPropertyDefinition } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
 export type { DocsBlockStorybookPropertyData, DocsBlockStorybookPropertyOptions, } from "./model/docs/blocks/properties/SDKDocsBlockStorybookProperty";
 export type { DocsColorRef } from "./model/docs/blocks/support/SDKDocsColorRef";
 export { DocsImageRefType } from "./model/docs/blocks/support/SDKDocsImageRef";
@@ -112,6 +116,7 @@ export { DocsLinkRefType } from "./model/docs/blocks/support/SDKDocsLinkRef";
 export type { DocsLinkRef } from "./model/docs/blocks/support/SDKDocsLinkRef";
 export type { DocsSizeRef } from "./model/docs/blocks/support/SDKDocsSizeRef";
 export { DocsBlock } from "./model/docs/blocks/usage/SDKDocsBlock";
+export { DocsBlockItem } from "./model/docs/blocks/usage/SDKDocsBlockItem";
 export { DocumentationLegacy } from "./model/base/SDKDocumentationLegacy";
 export { DocumentationLegacyPageBlockAsset } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockAsset";
 export { DocumentationLegacyPageBlockAssets } from "./model/documentation/blocks/SDKDocumentationLegacyPageBlockAssets";
@@ -175,6 +180,7 @@ export { DocumentationLegacyPageAssetType } from "./model/enums/SDKDocumentation
 export { DocumentationLegacyPageBlockType } from "./model/enums/SDKDocumentationLegacyPageBlockType";
 export { DocumentationLegacyPageBlockThemeType } from "./model/enums/SDKDocumentationLegacyPageBlockThemeType";
 export { DocsBlockBehaviorDataType } from "./model/enums/SDKDocsBlockBehaviorDataType";
+export { DocsBlockAssetPropertyPreviewContainerSize } from "./model/enums/SDKDocsBlockAssetPropertyPreviewContainerSize";
 export { DocsBlockBehaviorSelectionType } from "./model/enums/SDKDocsBlockBehaviorSelectionType";
 export { DocsBlockImagePropertyAspectRatio } from "./model/enums/SDKDocsBlockImagePropertyAspectRatio";
 export { DocsBlockItemEntityType } from "./model/enums/SDKDocsBlockItemEntityType";
@@ -187,10 +193,12 @@ export { DocsBlockItemVariantLayoutWidth } from "./model/enums/SDKDocsBlockItemV
 export { DocsBlockOptionRenderingStyle } from "./model/enums/SDKDocsBlockOptionRenderStyle";
 export { DocsBlockRichTextPropertyStyle } from "./model/enums/SDKDocsBlockRichTextPropertyStyle";
 export { DocsBlockTextPropertyStyle } from "./model/enums/SDKDocsBlockTextPropertyStyle";
+export { DocsBlockTextPropertyColor } from "./model/enums/SDKDocsBlockTextPropertyColor";
 export { DocsEntityGroupBehavior } from "./model/enums/SDKDocsEntityGroupBehavior";
 export { DocsEntityType } from "./model/enums/SDKDocsEntityType";
 export { DocsSectionType } from "./model/enums/SDKDocsSectionType";
 export { SourceType } from "./model/enums/SDKSourceType";
+export { DocsBlockImagePropertyWidth } from "./model/enums/SDKDocsBlockImagePropertyWidth";
 export { FrameAlignment } from "./model/enums/SDKFrameAlignment";
 export { FrameLayout } from "./model/enums/SDKFrameLayout";
 export { GradientType } from "./model/enums/SDKGradientType";
@@ -224,6 +232,9 @@ export { FigmaFrame, FrameType } from "./model/support/SDKFigmaFrame";
 export { ExportBuild } from "./model/exporters/exporter_builds/SDKExportBuild";
 export { ExportBuildStatus } from "./model/exporters/exporter_builds/SDKExportBuild";
 export { ExportBuildResultLog } from "./model/exporters/exporter_builds/SDKExportBuildResults";
+export type { ResourceType } from "./model/resources/SDKResource";
+export { ResourceAsset } from "./model/resources/SDKResourceAsset";
+export { ResourceFont } from "./model/resources/SDKResourceFont";
 export { BlurToken } from "./model/tokens/SDKBlurToken";
 export { BorderToken } from "./model/tokens/SDKBorderToken";
 export { ColorToken } from "./model/tokens/SDKColorToken";

package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockDefinition.d.ts

@@ -2,7 +2,7 @@ import { DocsBlockMode } from "../../../enums/SDKDocBlockMode";
 import { DocsBlockCategory } from "../../../enums/SDKDocsBlockCategory";
 import { DocsImageRef } from "../support/SDKDocsImageRef";
 import { DocsBlockBehavior, DocsBlockBehaviorModel } from "./SDKDocsBlockBehavior";
-import { DocsBlockItem, DocsBlockItemModel } from "./SDKDocsBlockItem";
+import { DocsBlockItemDefinition, DocsBlockItemDefinitionModel } from "./SDKDocsBlockItemDefinition";
 import { DocsBlockOnboarding, DocsBlockOnboardingModel } from "./SDKDocsBlockOnboarding";
 export type DocsBlockDefinitionModel = {
     id: string;
@@ -12,7 +12,7 @@ export type DocsBlockDefinitionModel = {
     icon?: DocsImageRef;
     documentationLink?: string;
     searchKeywords?: Array<string>;
-    item: DocsBlockItemModel;
+    item: DocsBlockItemDefinitionModel;
     behavior: DocsBlockBehaviorModel;
     editorOptions?: {
         onboarding?: DocsBlockOnboardingModel;
@@ -36,8 +36,8 @@ export declare class DocsBlockDefinition {
     /** Link to documentation or resource explaining the behavior of the block and its options */
     documentationLink: string | null;
     searchKeywords: Array<string>;
-    /** Primary definition of the block. See DocsBlockItem for more information */
-    item: DocsBlockItem;
+    /** Primary definition of the block. See DocsBlockItemDefinition for more information */
+    item: DocsBlockItemDefinition;
     /** Primary definition of the layered block behavior. See Block Behaviors for more information */
     behavior: DocsBlockBehavior;
     /** Top-level editor options for the block itself (but not for its items). This configuration has no bearing on front-end side of rendering and is only for editor */

package/build/sdk-typescript/src/model/docs/blocks/definition/{SDKDocsBlockItem.d.ts → SDKDocsBlockItemDefinition.d.ts}

@@ -1,6 +1,6 @@
 import { DocsBlockItemPropertyAnyDefinition } from "../properties/SDKDocsBlockProperty";
 import { DocsBlockVariant, DocsBlockVariantModel } from "./SDKDocsBlockVariant";
-export type DocsBlockItemModel = {
+export type DocsBlockItemDefinitionModel = {
     properties: Array<DocsBlockItemPropertyAnyDefinition>;
     appearance?: {
         isBordered?: boolean;
@@ -9,7 +9,7 @@ export type DocsBlockItemModel = {
     variants: Array<DocsBlockVariantModel>;
     defaultVariantKey: string;
 };
-export declare class DocsBlockItem {
+export declare class DocsBlockItemDefinition {
     /** All properties that user can potentially input via one block / item */
     properties: Array<DocsBlockItemPropertyAnyDefinition>;
     /** All appearance options for item wrapper */
@@ -23,5 +23,5 @@ export declare class DocsBlockItem {
     variants: Array<DocsBlockVariant>;
     /** Key of the default variant. There must always be at least one variant to point to */
     defaultVariantKey: string;
-    constructor(model: DocsBlockItemModel);
+    constructor(model: DocsBlockItemDefinitionModel);
 }

package/build/sdk-typescript/src/model/docs/blocks/definition/SDKDocsBlockVariant.d.ts

@@ -11,6 +11,7 @@ export type DocsBlockVariantModel = {
     appearance?: {
         isBordered?: boolean;
         hasBackground?: boolean;
+        isEditorPresentationDifferent?: boolean;
     };
 };
 export declare class DocsBlockVariant {
@@ -36,6 +37,8 @@ export declare class DocsBlockVariant {
         isBordered: boolean;
         /** When background option is enabled, background color can be set for the item */
         hasBackground: boolean;
+        /** When enabled, signifies that variants renders differently in the editor and in the published version */
+        isEditorPresentationDifferent: boolean;
     };
     constructor(model: DocsBlockVariantModel);
 }

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/assets/SDKDocsBlockActualAssets.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as Assets };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code/SDKDocsBlockActualCode.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as Code };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/code-react/SDKDocsBlockActualCodeReact.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as CodeReact };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist/SDKDocsBlockActualComponentChecklist.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as ComponentChecklist };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-checklist-all/SDKDocsBlockActualComponentChecklistAll.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as ComponentChecklistAll };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/component-health/SDKDocsBlockActualComponentHealth.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as ComponentHealth };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/figma-frames/SDKDocsBlockActualFigmaFrames.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as FigmaFrames };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/link/SDKDocsBlockActualLink.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/**
+ * 6. Block export
+ */
+export { block as Link };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-multi-item/SDKDocsBlockActualOmniMultiItem.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as OmniMultiItem };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/omni-single-item/SDKDocsBlockActualOmniSingleItem.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as OmniSingleItem };

package/build/sdk-typescript/src/model/docs/blocks/definition/actual/release-notes/SDKDocsBlockActualReleaseNotes.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 5. Block definition
+ */
+declare const block: import("../../SDKDocsBlockDefinition").DocsBlockDefinition;
+/** 6. Block export */
+export { block as ReleaseNotes };

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

@@ -1,3 +1,4 @@
+import { DocsBlockAssetPropertyPreviewContainerSize } from "../../../enums/SDKDocsBlockAssetPropertyPreviewContainerSize";
 import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
 import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
 /** Asset property - Additional non-value options */
@@ -9,6 +10,12 @@ export type DocsBlockAssetPropertyData = DocsBlockPropertyData<Array<{
 }>> & {
     /** Selected asset ids */
     selectedPropertyIds?: Array<string>;
+    /** If enabled, search is visible */
+    showSearch?: boolean;
+    /** Preview container size */
+    previewContainerSize?: DocsBlockAssetPropertyPreviewContainerSize.centered | DocsBlockAssetPropertyPreviewContainerSize.naturalHeight;
+    /** If enabled, each assets uses this for background */
+    backgroundColor?: string;
 };
 /** Asset property - Definition model */
 export type DocsBlockAssetPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyOptions;

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

@@ -1,7 +1,10 @@
 import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
 import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
 /** Code Sandbox property - Additional non-value options */
-export type DocsBlockCodeSandboxPropertyOptions = Record<string, never>;
+export type DocsBlockCodeSandboxPropertyOptions = {
+    /** How should we render the code example in editor */
+    renderLayoutAs?: "previewOnTop" | "previewOnBottom" | "previewOnLeft" | "previewOnRight";
+};
 /** Code Sandbox property - Data */
 export type DocsBlockCodeSandboxPropertyData = DocsBlockPropertyData<string> & {
     showCode?: boolean;

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

@@ -1,7 +1,12 @@
 import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
 import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
 /** Component property - Additional non-value options */
-export type DocsBlockComponentPropertyOptions = Record<string, never>;
+export type DocsBlockComponentPropertyOptions = {
+    /** How should the tokens be rendered in editor */
+    renderLayoutAs?: "list" | "table";
+    /** Whether to allow selecting component custom properties. True by default */
+    allowPropertySelection?: boolean;
+};
 /** Component property - Data */
 export type DocsBlockComponentPropertyData = DocsBlockPropertyData<Array<{
     entityId: string;

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

@@ -10,6 +10,8 @@ export type DocsBlockNumberPropertyOptions = {
     max: number;
     /** Step value */
     step: number;
+    /** Field placeholder */
+    placeholder?: string;
 };
 /** Number property - Data */
 export type DocsBlockNumberPropertyData = DocsBlockPropertyData<number> & Record<string, never>;

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

@@ -1,6 +1,7 @@
 import { RichTextSpan } from "../../../documentation/SDKDocumentationLegacyRichTextSpan";
 import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
 import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
+import { DocumentationLegacyCalloutType } from "../../../enums/SDKDocumentationLegacyCalloutType";
 import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
 /** RichText property - Additional non-value options */
 export type DocsBlockRichTextPropertyOptions = {
@@ -10,7 +11,10 @@ export type DocsBlockRichTextPropertyOptions = {
     style?: DocsBlockRichTextPropertyStyle;
 };
 /** RichText property - Data */
-export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<Array<RichTextSpan>> & Record<string, never>;
+export type DocsBlockRichTextPropertyData = DocsBlockPropertyData<Array<RichTextSpan>> & {
+    /** Selected token ids */
+    calloutType?: DocumentationLegacyCalloutType;
+};
 /** RichText property - Definition model */
 export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockRichTextPropertyOptions;
 /** RichText property - Definition */

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

@@ -4,7 +4,7 @@ import { DocsBlockTextPropertyStyle } from "../../../enums/SDKDocsBlockTextPrope
 import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
 /** Text property - Additional non-value options */
 export type DocsBlockTextPropertyOptions = {
-    /** Placeholder to show when textfield is empty */
+    /** Field placeholder */
     placeholder?: string;
     /** Default value to set when block is created */
     defaultValue?: string;

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

@@ -0,0 +1,14 @@
+import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
+import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
+/** Url property - Additional non-value options */
+export type DocsBlockUrlPropertyOptions = {
+    urlValidationRegex?: string;
+};
+/** Url property - Data */
+export type DocsBlockUrlPropertyData = DocsBlockPropertyData<string> & Record<string, never>;
+/** Url property - Definition model */
+export type DocsBlockUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockUrlPropertyOptions;
+/** Url property - Definition */
+export declare class DocsBlockUrlPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockUrlPropertyOptions, DocsBlockUrlPropertyData> {
+    type: DocsBlockItemPropertyType.embedURL;
+}

package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlock.d.ts

@@ -1,5 +1,6 @@
 import { DocsColorRef } from "../support/SDKDocsColorRef";
 import { DocsLinkRef } from "../support/SDKDocsLinkRef";
+import { DocsBlockItem } from "./SDKDocsBlockItem";
 export type DocsBlockModel = {
     id: string;
     packageId: string;
@@ -8,12 +9,14 @@ export type DocsBlockModel = {
     appearance?: {
         itemBackgroundColor?: DocsColorRef;
     };
-    data?: Array<{
-        props: {
-            [key: string]: object;
-        };
-        linksTo?: DocsLinkRef;
-    }>;
+    data?: Array<DocsBlockItemDefinitionModel>;
+};
+export type DocsBlockItemDefinitionModel = {
+    id: string;
+    props: {
+        [key: string]: object;
+    };
+    linksTo?: DocsLinkRef;
 };
 export declare class DocsBlock {
     /** Unique identifier of the block */
@@ -29,19 +32,8 @@ export declare class DocsBlock {
         /** Background color of all items of the block. Can be further overriden on every item */
         itemBackgroundColor: DocsColorRef | null;
     };
-    /** Static data represents data for items that are created without dynamic reference to entities in Supernova - an example of this would be a shortcut.
-     * This is an array, because for blocks with items being able to form grids, we need more than a single definition (each item has its own settings then)
-     * Property resolution:
-     *   data > default (in block property definition) > not set
-     */
-    data: Array<{
-        /** Dynamic key coming from property.id block definition */
-        props: {
-            [key: string]: object;
-        };
-        /** Link where the item points to, if any. Must be enabled in behaviors */
-        linksTo?: DocsLinkRef;
-    }>;
+    /** Data of all items of the block */
+    data: Array<DocsBlockItem>;
     constructor(model: DocsBlockModel);
     /** Returns stored data of all properties. This will retrieve properties for item on the first position, ideal for single-item blocks */
     allPropertyDataForSingleItem(): Record<string, object> | null;
@@ -63,4 +55,6 @@ export declare class DocsBlock {
     updateLinkForItemAtIndex(index: number, link: DocsLinkRef | null): void;
     /** Update link for item at specific index */
     updateLinkForSingleItem(link: DocsLinkRef | null): void;
+    /** Constructs representation that can be used to write full object to remote */
+    toRemote(): DocsBlockModel;
 }

package/build/sdk-typescript/src/model/docs/blocks/usage/SDKDocsBlockItem.d.ts

@@ -0,0 +1,21 @@
+import { DocsLinkRef } from "../support/SDKDocsLinkRef";
+export type DocsBlockItemModel = {
+    id: string;
+    props: {
+        [key: string]: object;
+    };
+    linksTo?: DocsLinkRef;
+};
+export declare class DocsBlockItem {
+    /** Unique identifier of the block item */
+    id: string;
+    /** Dynamic key coming from property.id block definition */
+    props: {
+        [key: string]: object;
+    };
+    /** Link where the item points to, if any. Must be enabled in behaviors */
+    linksTo: DocsLinkRef | undefined;
+    constructor(model: DocsBlockItemModel);
+    /** Constructs representation that can be used to write full object to remote */
+    toRemote(): DocsBlockItemModel;
+}

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

@@ -0,0 +1,6 @@
+export declare enum DocsBlockAssetPropertyPreviewContainerSize {
+    /** Default. Image is centered within a container */
+    centered = "Centered",
+    /** The container has the height of the asset within */
+    naturalHeight = "NaturalHeight"
+}

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

@@ -6,5 +6,7 @@ export declare enum DocsBlockBehaviorDataType {
     /** Asset type allows selection of asset entity and associated groups * */
     asset = "Asset",
     /** Component type allows selection of asset entity and associated groups * */
-    component = "Component"
+    component = "Component",
+    /** Figma frame type allows selection of any frame coming from Figma * */
+    figmaFrame = "FigmaFrame"
 }

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

@@ -1,9 +1,11 @@
 export declare enum DocsBlockImagePropertyAspectRatio {
+    /** Default. Automatic aspect ratio */
+    auto = "Auto",
     /** 1:1 aspect ratio */
     square = "Square",
-    /** 4:3 aspect ratio */
+    /** 3:2 aspect ratio */
     landscape = "Landscape",
-    /** 3:4 aspect ratio */
+    /** 2:3 aspect ratio */
     portrait = "Portrait",
     /** 16:9 aspect ratio */
     wide = "Wide"

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

@@ -1,4 +1,6 @@
 export declare enum DocsBlockImagePropertyWidth {
+    /** Default. Translates to width: 100% */
+    full = "Full",
     /** width: 48px */
     icon = "Icon",
     /** width: 120px */

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

@@ -31,6 +31,8 @@ export declare enum DocsBlockItemPropertyType {
     /** Page property allows selection of custom page properties (columns) */
     /** Embed property allows user to input page to be embedded via URL */
     embedURL = "EmbedURL",
+    /** URL property allows user to input a valid URL */
+    url = "URL",
     /** Embed property allows user to input page to be embedded via iframe */
     /** Markdown property allows user to add markdown to render */
     markdown = "Markdown",

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

@@ -1,4 +1,5 @@
 export declare enum SourceType {
     figma = "Figma",
-    tokenStudio = "TokenStudio"
+    tokenStudio = "TokenStudio",
+    figmaVariablesPlugin = "FigmaVariablesPlugin"
 }