@supernova-studio/supernova-sdk-beta 2.4.6 → 2.4.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/build/types/core/SDKSupernova.d.ts +9 -0
- package/build/types/core/areas/SDKAreaActivityEvents.d.ts +7 -0
- package/build/types/core/areas/SDKAreaAgentChats.d.ts +12 -0
- package/build/types/core/areas/SDKAreaBulkOperations.d.ts +76 -74
- package/build/types/core/areas/SDKAreaDataSources.d.ts +1 -1
- package/build/types/core/areas/SDKAreaDesignSystems.d.ts +13 -13
- package/build/types/core/areas/SDKAreaDocumentation.d.ts +304 -289
- package/build/types/core/areas/SDKAreaImport.d.ts +35 -0
- package/build/types/core/areas/SDKAreaMCP.d.ts +26 -1
- package/build/types/core/areas/SDKAreaProjects.d.ts +1084 -1100
- package/build/types/core/areas/SDKAreaRawData.d.ts +1040 -1039
- package/build/types/core/areas/SDKAreaResources.d.ts +90 -90
- package/build/types/core/areas/SDKAreaSanboxes.d.ts +9 -9
- package/build/types/core/areas/SDKAreaThreads.d.ts +67 -67
- package/build/types/core/areas/SDKAreaTokens.d.ts +17 -12
- package/build/types/core/areas/SDKAreaWorkspaces.d.ts +1 -1
- package/build/types/core/data/SDKDataCore.d.ts +1771 -1746
- package/build/types/core/data/SDKDataCoreCached.d.ts +2 -2
- package/build/types/core/data/requests/SDKDataCoreReadRequests.d.ts +647 -593
- package/build/types/core/data/requests/SDKDataCoreWriteRequests.d.ts +2515 -2489
- package/build/types/core/resolvers/SDKDocsEntityItemResolver.d.ts +121 -121
- package/build/types/core/resolvers/SDKSnapshotTokenBuilder.d.ts +28 -0
- package/build/types/core/resolvers/SDKTokenResolver.d.ts +11 -9
- package/build/types/exports.d.ts +19 -11
- package/build/types/model/activity-events/SDKActivityEvent.d.ts +49 -0
- package/build/types/model/agent-chats/SDKAgentChat.d.ts +31 -0
- package/build/types/model/base/SDKDesignSystem.d.ts +3 -1
- package/build/types/model/datasets/SDKDataset.d.ts +15 -5
- package/build/types/model/docs/blocks/definition/SDKDocsBlockBehavior.d.ts +4 -1
- package/build/types/model/docs/blocks/definition/actual/context-mcp/SDKDocsBlockActualContextMcp.d.ts +2 -0
- package/build/types/model/docs/blocks/properties/SDKDocsBlockAssetProperty.d.ts +7 -24
- package/build/types/model/docs/blocks/properties/SDKDocsBlockAssetPropertyProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockBooleanProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockCodeProperty.d.ts +3 -6
- package/build/types/model/docs/blocks/properties/SDKDocsBlockCodeSandboxProperty.d.ts +3 -8
- package/build/types/model/docs/blocks/properties/SDKDocsBlockColorProperty.d.ts +3 -3
- package/build/types/model/docs/blocks/properties/SDKDocsBlockComponentProperty.d.ts +7 -10
- package/build/types/model/docs/blocks/properties/SDKDocsBlockComponentPropertyProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockContextProperty.d.ts +16 -0
- package/build/types/model/docs/blocks/properties/SDKDocsBlockDividerProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockEmbedUrlProperty.d.ts +3 -6
- package/build/types/model/docs/blocks/properties/SDKDocsBlockFigmaComponentProperty.d.ts +7 -26
- package/build/types/model/docs/blocks/properties/SDKDocsBlockFigmaNodeProperty.d.ts +7 -22
- package/build/types/model/docs/blocks/properties/SDKDocsBlockFileProperty.d.ts +4 -9
- package/build/types/model/docs/blocks/properties/SDKDocsBlockImageProperty.d.ts +3 -10
- package/build/types/model/docs/blocks/properties/SDKDocsBlockMarkdownProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockMultiRichTextProperty.d.ts +3 -3
- package/build/types/model/docs/blocks/properties/SDKDocsBlockMultiSelectProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockNumberProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockProperty.d.ts +3 -3
- package/build/types/model/docs/blocks/properties/SDKDocsBlockRichTextEditorProperty.d.ts +3 -3
- package/build/types/model/docs/blocks/properties/SDKDocsBlockRichTextProperty.d.ts +3 -7
- package/build/types/model/docs/blocks/properties/SDKDocsBlockSingleSelectProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockStorybookProperty.d.ts +4 -22
- package/build/types/model/docs/blocks/properties/SDKDocsBlockTableProperty.d.ts +12 -28
- package/build/types/model/docs/blocks/properties/SDKDocsBlockTextProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockTokenProperty.d.ts +7 -31
- package/build/types/model/docs/blocks/properties/SDKDocsBlockTokenPropertyProperty.d.ts +3 -2
- package/build/types/model/docs/blocks/properties/SDKDocsBlockTokenTypeProperty.d.ts +3 -3
- package/build/types/model/docs/blocks/properties/SDKDocsBlockUrlProperty.d.ts +3 -2
- package/build/types/model/docs/sections/SDKDocsSection.d.ts +0 -31
- package/build/types/model/documentation/SDKPageHistoryVersion.d.ts +20 -0
- package/build/types/model/documentation/blocks/SDKDocumentationLegacyPageBlockContextMcp.d.ts +11 -0
- package/build/types/model/elements/SDKElementPropertyOption.d.ts +1 -2
- package/build/types/model/enums/SDKCodeLanguage.d.ts +1 -1
- package/build/types/model/enums/SDKDesignSystemRole.d.ts +1 -2
- package/build/types/model/enums/SDKDocsBlockBehaviorSelectionType.d.ts +4 -2
- package/build/types/model/enums/SDKDocsBlockContainerSize.d.ts +6 -4
- package/build/types/model/enums/SDKDocsBlockItemPropertyType.d.ts +3 -1
- package/build/types/model/enums/SDKDocumentationLegacyPageBlockType.d.ts +1 -0
- package/build/types/model/enums/SDKTokenType.d.ts +2 -0
- package/build/types/model/enums/SDKWorkspaceSeatType.d.ts +14 -3
- package/build/types/model/exporters/SDKExporter.d.ts +2 -2
- package/build/types/model/exporters/SDKPipeline.d.ts +1 -1
- package/build/types/model/membership/SDKMembership.d.ts +1 -1
- package/build/types/model/support/SDKSource.d.ts +4 -3
- package/build/types/model/themes/SDKTokenThemeOverride.d.ts +1 -0
- package/build/types/model/tokens/remote/SDKRemoteTokenModel.d.ts +34 -1
- package/build/types/model/tokens/remote/SDKRemoteTokenValue.d.ts +1 -1
- package/build/types/model/workspaces/SDKWorkspaceProductPrice.d.ts +6 -3
- package/build/types/model/workspaces/SDKWorkspaceSubscription.d.ts +2 -6
- package/build/types/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +6 -3
- package/build/types/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +29 -3
- package/build/types/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +2 -0
- package/build/types/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +31 -0
- package/build/types/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +2 -0
- package/build/types/tools/design-tokens/utilities/unresolvable-modes/index.d.ts +4 -0
- package/build/types/tools/design-tokens/utilities/unresolvable-modes/lenient-resolve.d.ts +2 -0
- package/build/types/tools/design-tokens/utilities/unresolvable-modes/placeholder.d.ts +2 -0
- package/build/types/tools/design-tokens/utilities/unresolvable-modes/preserve.d.ts +2 -0
- package/build/types/tools/design-tokens/utilities/unresolvable-modes/strict.d.ts +2 -0
- package/build/types/tools/design-tokens/utilities/unresolvable-modes/types.d.ts +33 -0
- package/build/types/tools/docs-block-builder/SDKDocsBlockBuilder.d.ts +9 -0
- package/build/types/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +1 -1
- package/build/types/utils/TokenUtils.d.ts +1 -1
- package/package.json +17 -21
- package/build/types/model/enums/SDKDocsBlockTokenNameFormat.d.ts +0 -10
|
@@ -5,7 +5,7 @@ export type DesignSystemSwitcher = {
|
|
|
5
5
|
designSystemIds: Array<string>;
|
|
6
6
|
};
|
|
7
7
|
export type DesignSystemAccessMode = "Open" | "InviteOnly";
|
|
8
|
-
export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId">;
|
|
8
|
+
export type DesignSystemTransportModel = Pick<DesignSystem, "id" | "name" | "description" | "isPublic" | "isMultiBrand" | "documentationSlug" | "documentationUserSlug" | "documentationExporterId" | "designSystemSwitcher" | "workspaceId" | "createdAt">;
|
|
9
9
|
export declare class DesignSystem {
|
|
10
10
|
/** Unique identifier of design system */
|
|
11
11
|
id: string;
|
|
@@ -45,6 +45,8 @@ export declare class DesignSystem {
|
|
|
45
45
|
isAvailableToUser: boolean;
|
|
46
46
|
/** Unique identifier of the shared draft version of the design system */
|
|
47
47
|
sharedDraftId: string;
|
|
48
|
+
/** When the design system was created */
|
|
49
|
+
createdAt: Date;
|
|
48
50
|
constructor(model: Omit<DTODesignSystem, "isPublic"> & {
|
|
49
51
|
isPublic: boolean;
|
|
50
52
|
});
|
|
@@ -34,6 +34,7 @@ export type DatasetEntityFieldMap = {
|
|
|
34
34
|
id: string;
|
|
35
35
|
name: string;
|
|
36
36
|
description: string;
|
|
37
|
+
[property: `customProperties.${string}`]: string | number | boolean | null;
|
|
37
38
|
};
|
|
38
39
|
assets: {
|
|
39
40
|
id: string;
|
|
@@ -152,6 +153,15 @@ type DatasetPropertyGetter<TEntity extends DatasetEntity> = (item: TEntity, prop
|
|
|
152
153
|
* which the SDK already normalizes to the persistent form on construction.
|
|
153
154
|
*/
|
|
154
155
|
export declare const getDatasetFilterEntityId: <TItem extends DatasetFilterItem>(item: TItem, entityType: DatasetEntityType) => string;
|
|
156
|
+
export type DatasetEvaluatedPropertyCondition = {
|
|
157
|
+
type: "property";
|
|
158
|
+
property: string;
|
|
159
|
+
operator: DatasetPropertyOperator;
|
|
160
|
+
value?: DatasetConditionValue;
|
|
161
|
+
};
|
|
162
|
+
export type DatasetFilterEvaluationOptions = {
|
|
163
|
+
isPropertyConditionValid?: (condition: DatasetEvaluatedPropertyCondition) => boolean;
|
|
164
|
+
};
|
|
155
165
|
export declare class DatasetSelectionBuilder<TEntity extends DatasetEntityType> {
|
|
156
166
|
and(children: readonly DatasetFilterNode<TEntity>[]): DatasetFilterGroup<TEntity>;
|
|
157
167
|
or(children: readonly DatasetFilterNode<TEntity>[]): DatasetFilterGroup<TEntity>;
|
|
@@ -177,8 +187,8 @@ export declare class SDKDataset {
|
|
|
177
187
|
private readonly refinedBaseDataset?;
|
|
178
188
|
constructor(data?: SDKDatasetData, refinedSourceDataset?: SDKDataset, refinedBaseDataset?: SDKDataset);
|
|
179
189
|
static create(designSystemId?: string | null): SDKDataset;
|
|
180
|
-
static and(children: readonly DatasetFilterNode[]): DatasetFilterGroup
|
|
181
|
-
static or(children: readonly DatasetFilterNode[]): DatasetFilterGroup
|
|
190
|
+
static and<TEntity extends DatasetEntityType = DatasetEntityType>(children: readonly DatasetFilterNode<TEntity>[]): DatasetFilterGroup<TEntity>;
|
|
191
|
+
static or<TEntity extends DatasetEntityType = DatasetEntityType>(children: readonly DatasetFilterNode<TEntity>[]): DatasetFilterGroup<TEntity>;
|
|
182
192
|
static includeAll(): DatasetIncludeAllCondition;
|
|
183
193
|
static includeIds(ids: readonly string[]): DatasetIncludeIdsCondition;
|
|
184
194
|
static excludeIds(ids: readonly string[]): DatasetExcludeIdsCondition;
|
|
@@ -198,15 +208,15 @@ export declare class SDKDataset {
|
|
|
198
208
|
filteredSkills<TSkill extends DatasetFilterItem>(allSkills: readonly TSkill[], inheritedDataset?: SDKDataset): DatasetFilterResult<TSkill>[];
|
|
199
209
|
filteredFiles<TFile extends DatasetFilterItem>(allFiles: readonly TFile[], inheritedDataset?: SDKDataset): DatasetFilterResult<TFile>[];
|
|
200
210
|
filteredCodeComponents<TCodeComponent extends DatasetFilterItem>(allCodeComponents: readonly TCodeComponent[], inheritedDataset?: SDKDataset): DatasetFilterResult<TCodeComponent>[];
|
|
201
|
-
filteredItems<TItem extends DatasetFilterItem>(entityType: DatasetEntityType, allItems: readonly TItem[], inheritedDataset?: SDKDataset, projectItem?: DatasetItemProjector<TItem
|
|
211
|
+
filteredItems<TItem extends DatasetFilterItem>(entityType: DatasetEntityType, allItems: readonly TItem[], inheritedDataset?: SDKDataset, projectItem?: DatasetItemProjector<TItem>, evaluationOptions?: DatasetFilterEvaluationOptions): Array<DatasetFilterResult<TItem>>;
|
|
202
212
|
/**
|
|
203
213
|
* Id-only membership check against the dataset's scope for one entity type.
|
|
204
214
|
* Walks the filter tree for `includeAll`, `includeIds`, `excludeIds` and
|
|
205
215
|
* returns a structured reason. Does not evaluate property predicates — for
|
|
206
216
|
* those use `filteredItems`.
|
|
207
217
|
*
|
|
208
|
-
* Default for a missing filter group:
|
|
209
|
-
*
|
|
218
|
+
* Default for a missing filter group: strict-default entities drop, every
|
|
219
|
+
* other entity passes.
|
|
210
220
|
*/
|
|
211
221
|
isIdInScope(entityType: DatasetEntityType, id: string): DatasetIdInScopeResult;
|
|
212
222
|
isEmpty(): boolean;
|
|
@@ -24,7 +24,10 @@ export declare class DocsBlockBehavior {
|
|
|
24
24
|
/**
|
|
25
25
|
* If selectionType === "Entity", then only an entity of specific "dataType" can be selected (and no groups of that type)
|
|
26
26
|
* If selectionType === "Group", then only a group of specific "dataType" can be selected (and no entity of that type)
|
|
27
|
-
* If selectionType === "EntityAndGroup", then
|
|
27
|
+
* If selectionType === "EntityAndGroup", then either can be selected, but never both at once
|
|
28
|
+
* If selectionType === "None", then nothing can be selected: the block derives its own content
|
|
29
|
+
*
|
|
30
|
+
* At most one group can be selected, whichever type allows groups
|
|
28
31
|
*/
|
|
29
32
|
selectionType: DocsBlockBehaviorSelectionType;
|
|
30
33
|
/**
|
|
@@ -1,31 +1,14 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemAssetValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
-
import {
|
|
4
|
-
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
4
|
/** Asset property - Additional non-value options */
|
|
6
5
|
export type DocsBlockAssetPropertyOptions = Record<string, never>;
|
|
7
6
|
/** Asset property - Data */
|
|
8
|
-
export type DocsBlockAssetPropertyData =
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
description?: string;
|
|
14
|
-
backgroundColor?: DocsColorRef | null;
|
|
15
|
-
showNestedGroups?: boolean;
|
|
16
|
-
};
|
|
17
|
-
}>> & {
|
|
18
|
-
/** Selected asset ids */
|
|
19
|
-
selectedPropertyIds?: Array<string>;
|
|
20
|
-
/** If enabled, search is visible */
|
|
21
|
-
showSearch?: boolean;
|
|
22
|
-
/** If enabled, description is visible */
|
|
23
|
-
showAssetDescription?: boolean;
|
|
24
|
-
/** Preview container size */
|
|
25
|
-
previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
|
|
26
|
-
/** Preview container height */
|
|
27
|
-
previewContainerHeight?: number;
|
|
28
|
-
};
|
|
7
|
+
export type DocsBlockAssetPropertyData = PageBlockItemAssetValue;
|
|
8
|
+
/** Asset property - Value */
|
|
9
|
+
export type DocsBlockAssetPropertyValue = DocsBlockAssetPropertyData["value"];
|
|
10
|
+
/** Asset property - Entity */
|
|
11
|
+
export type DocsBlockAssetPropertyEntity = DocsBlockAssetPropertyValue[number];
|
|
29
12
|
/** Asset property - Definition model */
|
|
30
13
|
export type DocsBlockAssetPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyOptions;
|
|
31
14
|
/** Asset property - Definition */
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
import type { PageBlockItemAssetPropertyValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** Asset property property - Additional non-value options */
|
|
4
5
|
export type DocsBlockAssetPropertyPropertyOptions = Record<string, never>;
|
|
5
6
|
/** Asset property property - Data */
|
|
6
|
-
export type DocsBlockAssetPropertyPropertyData =
|
|
7
|
+
export type DocsBlockAssetPropertyPropertyData = PageBlockItemAssetPropertyValue;
|
|
7
8
|
/** Asset property property - Definition model */
|
|
8
9
|
export type DocsBlockAssetPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockAssetPropertyPropertyOptions;
|
|
9
10
|
/** Asset property property - Definition */
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
import type { PageBlockItemBooleanValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyOptionRenderingStyle } from "../../../enums/SDKDocsBlockItemPropertyOptionRenderingStyle";
|
|
2
3
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
-
import {
|
|
4
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
5
|
/** Boolean property - Additional non-value options */
|
|
5
6
|
export type DocsBlockBooleanPropertyOptions = {
|
|
6
7
|
/** Default value to set when block is created */
|
|
@@ -9,7 +10,7 @@ export type DocsBlockBooleanPropertyOptions = {
|
|
|
9
10
|
booleanStyle?: Exclude<DocsBlockItemPropertyOptionRenderingStyle, DocsBlockItemPropertyOptionRenderingStyle.select>;
|
|
10
11
|
};
|
|
11
12
|
/** Boolean property - Data */
|
|
12
|
-
export type DocsBlockBooleanPropertyData =
|
|
13
|
+
export type DocsBlockBooleanPropertyData = PageBlockItemBooleanValue;
|
|
13
14
|
/** Boolean property - Definition model */
|
|
14
15
|
export type DocsBlockBooleanPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockBooleanPropertyOptions;
|
|
15
16
|
/** Boolean property - Definition */
|
|
@@ -1,15 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemCodeValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
4
|
/** Code property - Additional non-value options */
|
|
5
5
|
export type DocsBlockCodePropertyOptions = {
|
|
6
6
|
shouldHideCodeSyntax?: boolean;
|
|
7
7
|
};
|
|
8
8
|
/** Code property - Data */
|
|
9
|
-
export type DocsBlockCodePropertyData =
|
|
10
|
-
format?: CodeLanguage;
|
|
11
|
-
caption?: string;
|
|
12
|
-
};
|
|
9
|
+
export type DocsBlockCodePropertyData = PageBlockItemCodeValue;
|
|
13
10
|
/** Code property - Definition model */
|
|
14
11
|
export type DocsBlockCodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodePropertyOptions;
|
|
15
12
|
/** Code property - Definition */
|
|
@@ -1,18 +1,13 @@
|
|
|
1
|
+
import type { PageBlockItemSandboxValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** Code Sandbox property - Additional non-value options */
|
|
4
5
|
export type DocsBlockCodeSandboxPropertyOptions = {
|
|
5
6
|
/** How should we render the code example in editor */
|
|
6
7
|
renderLayoutAs?: "PreviewOnTop" | "PreviewOnBottom" | "PreviewOnLeft" | "PreviewOnRight";
|
|
7
8
|
};
|
|
8
9
|
/** Code Sandbox property - Data */
|
|
9
|
-
export type DocsBlockCodeSandboxPropertyData =
|
|
10
|
-
showCode?: boolean;
|
|
11
|
-
showControls?: boolean;
|
|
12
|
-
backgroundColor?: string;
|
|
13
|
-
alignPreview?: "Left" | "Center";
|
|
14
|
-
previewHeight?: number;
|
|
15
|
-
};
|
|
10
|
+
export type DocsBlockCodeSandboxPropertyData = PageBlockItemSandboxValue;
|
|
16
11
|
/** Code Sandbox property - Definition model */
|
|
17
12
|
export type DocsBlockCodeSandboxPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockCodeSandboxPropertyOptions;
|
|
18
13
|
/** Code Sandbox property - Definition */
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
import type { PageBlockItemColorValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
-
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
4
|
/** Color property - Additional non-value options */
|
|
5
5
|
export type DocsBlockColorPropertyOptions = Record<string, never>;
|
|
6
6
|
/** Color property - Data */
|
|
7
|
-
export type DocsBlockColorPropertyData =
|
|
7
|
+
export type DocsBlockColorPropertyData = PageBlockItemColorValue;
|
|
8
8
|
/** Color property - Definition model */
|
|
9
9
|
export type DocsBlockColorPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockColorPropertyOptions;
|
|
10
10
|
/** Color property - Definition */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import type { PageBlockItemComponentValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** Component property - Additional non-value options */
|
|
4
5
|
export type DocsBlockComponentPropertyOptions = {
|
|
5
6
|
/** How should the tokens be rendered in editor */
|
|
@@ -8,15 +9,11 @@ export type DocsBlockComponentPropertyOptions = {
|
|
|
8
9
|
allowPropertySelection?: boolean;
|
|
9
10
|
};
|
|
10
11
|
/** Component property - Data */
|
|
11
|
-
export type DocsBlockComponentPropertyData =
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
selectedPropertyIds?: Array<string>;
|
|
17
|
-
/** Brand id */
|
|
18
|
-
selectedBrandId?: string;
|
|
19
|
-
};
|
|
12
|
+
export type DocsBlockComponentPropertyData = PageBlockItemComponentValue;
|
|
13
|
+
/** Component property - Value */
|
|
14
|
+
export type DocsBlockComponentPropertyValue = DocsBlockComponentPropertyData["value"];
|
|
15
|
+
/** Component property - Entity */
|
|
16
|
+
export type DocsBlockComponentPropertyEntity = DocsBlockComponentPropertyValue[number];
|
|
20
17
|
/** Component property - Definition model */
|
|
21
18
|
export type DocsBlockComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyOptions;
|
|
22
19
|
/** Component property - Definition */
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
import type { PageBlockItemComponentPropertyValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** ComponentProperty property - Additional non-value options */
|
|
4
5
|
export type DocsBlockComponentPropertyPropertyOptions = Record<string, never>;
|
|
5
6
|
/** ComponentProperty property - Data */
|
|
6
|
-
export type DocsBlockComponentPropertyPropertyData =
|
|
7
|
+
export type DocsBlockComponentPropertyPropertyData = PageBlockItemComponentPropertyValue;
|
|
7
8
|
/** ComponentProperty property - Definition model */
|
|
8
9
|
export type DocsBlockComponentPropertyPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockComponentPropertyPropertyOptions;
|
|
9
10
|
/** ComponentProperty property - Definition */
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { PageBlockContextConnection, type PageBlockItemContextValue } from "@supernova-studio/model";
|
|
2
|
+
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
export declare const DocsBlockContextPropertyConnectionValues: ("url" | "cursor" | "claudeCode" | "vsCode" | "codex" | "codeSnippet")[];
|
|
5
|
+
export type DocsBlockContextPropertyConnection = PageBlockContextConnection;
|
|
6
|
+
export type DocsBlockContextPropertyOptions = Record<string, never>;
|
|
7
|
+
/** Context property - Data */
|
|
8
|
+
export type DocsBlockContextPropertyData = PageBlockItemContextValue;
|
|
9
|
+
/** Context property - Value */
|
|
10
|
+
export type DocsBlockContextPropertyValue = DocsBlockContextPropertyData["value"];
|
|
11
|
+
/** Context property - Entity */
|
|
12
|
+
export type ContextEntity = DocsBlockContextPropertyValue[number];
|
|
13
|
+
export type DocsBlockContextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockContextPropertyOptions;
|
|
14
|
+
export declare class DocsBlockContextPropertyDefinition extends DocsBlockPropertyDefinition<DocsBlockContextPropertyOptions, DocsBlockContextPropertyData> {
|
|
15
|
+
type: DocsBlockItemPropertyType.context;
|
|
16
|
+
}
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
import type { PageBlockItemDividerValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** Divider property - Additional non-value options */
|
|
4
5
|
export type DocsBlockDividerPropertyOptions = Record<string, never>;
|
|
5
6
|
/** Divider property - Data */
|
|
6
|
-
export type DocsBlockDividerPropertyData =
|
|
7
|
+
export type DocsBlockDividerPropertyData = PageBlockItemDividerValue;
|
|
7
8
|
/** Divider property - Definition model */
|
|
8
9
|
export type DocsBlockDividerPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockDividerPropertyOptions;
|
|
9
10
|
/** Divider property - Definition */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import type { PageBlockItemEmbedValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** EmbedUrl property - Additional non-value options */
|
|
4
5
|
export type DocsBlockEmbedUrlPropertyOptions = {
|
|
5
6
|
/** Defines what should be the default height of the embed */
|
|
@@ -14,11 +15,7 @@ export type DocsBlockEmbedUrlPropertyOptions = {
|
|
|
14
15
|
isInteractive?: boolean;
|
|
15
16
|
};
|
|
16
17
|
/** EmbedUrl property - Data */
|
|
17
|
-
export type DocsBlockEmbedUrlPropertyData =
|
|
18
|
-
alt?: string;
|
|
19
|
-
caption?: string;
|
|
20
|
-
height?: number;
|
|
21
|
-
};
|
|
18
|
+
export type DocsBlockEmbedUrlPropertyData = PageBlockItemEmbedValue;
|
|
22
19
|
/** EmbedUrl property - Definition model */
|
|
23
20
|
export type DocsBlockEmbedUrlPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockEmbedUrlPropertyOptions;
|
|
24
21
|
/** EmbedUrl property - Definition */
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemFigmaComponentValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
4
|
/** Figma Component property - Additional non-value options */
|
|
5
5
|
export type DocsBlockFigmaComponentPropertyOptions = {
|
|
6
6
|
/** How should the Figma component data be rendered in editor.
|
|
@@ -14,30 +14,11 @@ export type DocsBlockFigmaComponentPropertyOptions = {
|
|
|
14
14
|
invertPropertySelection?: boolean;
|
|
15
15
|
};
|
|
16
16
|
/** Figma Component property - Data */
|
|
17
|
-
export type DocsBlockFigmaComponentPropertyData =
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
selectedComponentVariants?: Record<string, Array<string>>;
|
|
23
|
-
};
|
|
24
|
-
}>> & {
|
|
25
|
-
/** Preview container size */
|
|
26
|
-
previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
|
|
27
|
-
/** Preview container height */
|
|
28
|
-
previewContainerHeight?: number;
|
|
29
|
-
/** If enabled, the component title will be visible in the block */
|
|
30
|
-
showComponentName?: boolean;
|
|
31
|
-
/** If enabled, the component description list will be visible in the block */
|
|
32
|
-
showComponentDescription?: boolean;
|
|
33
|
-
/** If enabled, the list of properties list will be visible in the block */
|
|
34
|
-
showPropertyList?: boolean;
|
|
35
|
-
/**
|
|
36
|
-
* Defines the order for preview rendering using a list of entity IDs.
|
|
37
|
-
* If not specified, the default order is applied.
|
|
38
|
-
*/
|
|
39
|
-
previewOrderIds?: Array<string>;
|
|
40
|
-
};
|
|
17
|
+
export type DocsBlockFigmaComponentPropertyData = PageBlockItemFigmaComponentValue;
|
|
18
|
+
/** Figma Component property - Value */
|
|
19
|
+
export type DocsBlockFigmaComponentPropertyValue = DocsBlockFigmaComponentPropertyData["value"];
|
|
20
|
+
/** Figma Component property - Entity */
|
|
21
|
+
export type DocsBlockFigmaComponentPropertyEntity = DocsBlockFigmaComponentPropertyValue[number];
|
|
41
22
|
/** Figma Component property - Definition model */
|
|
42
23
|
export type DocsBlockFigmaComponentPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFigmaComponentPropertyOptions;
|
|
43
24
|
/** Figma Component property - Definition */
|
|
@@ -1,29 +1,14 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemFigmaNodeValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
|
-
import {
|
|
4
|
-
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
4
|
/** FigmaNode property - Additional non-value options */
|
|
6
5
|
export type DocsBlockFigmaNodePropertyOptions = Record<string, never>;
|
|
7
6
|
/** FigmaNode property - Data */
|
|
8
|
-
export type DocsBlockFigmaNodePropertyData =
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
backgroundColor?: DocsColorRef | null;
|
|
14
|
-
};
|
|
15
|
-
}>> & {
|
|
16
|
-
/** Behavior of container size */
|
|
17
|
-
previewContainerSize?: DocsBlockContainerSize.centered | DocsBlockContainerSize.naturalHeight;
|
|
18
|
-
/** Preview container height */
|
|
19
|
-
previewContainerHeight?: number;
|
|
20
|
-
/** If enabled, search is visible */
|
|
21
|
-
showSearch?: boolean;
|
|
22
|
-
/** Number of columns */
|
|
23
|
-
columns?: number;
|
|
24
|
-
/** Shows details of each frame, or hides them all */
|
|
25
|
-
showFrameDetails?: boolean;
|
|
26
|
-
};
|
|
7
|
+
export type DocsBlockFigmaNodePropertyData = PageBlockItemFigmaNodeValue;
|
|
8
|
+
/** FigmaNode property - Value */
|
|
9
|
+
export type DocsBlockFigmaNodePropertyValue = DocsBlockFigmaNodePropertyData["value"];
|
|
10
|
+
/** FigmaNode property - Entity */
|
|
11
|
+
export type DocsBlockFigmaNodePropertyEntity = DocsBlockFigmaNodePropertyValue[number];
|
|
27
12
|
/** FigmaNode property - Definition model */
|
|
28
13
|
export type DocsBlockFigmaNodePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFigmaNodePropertyOptions;
|
|
29
14
|
/** FigmaNode property - Definition */
|
|
@@ -1,19 +1,14 @@
|
|
|
1
|
+
import type { PageBlockItemFileValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** File property - Additional non-value options */
|
|
4
5
|
export type DocsBlockFilePropertyOptions = {
|
|
5
6
|
renderLayoutAs: "iconOnTop" | "iconOnLeft";
|
|
6
7
|
editorInteractivity?: "edit" | "viewOnly";
|
|
7
8
|
};
|
|
8
9
|
/** File property - Data */
|
|
9
|
-
export type DocsBlockFilePropertyValue =
|
|
10
|
-
|
|
11
|
-
entityMeta?: {
|
|
12
|
-
title?: string;
|
|
13
|
-
description?: string;
|
|
14
|
-
};
|
|
15
|
-
}>;
|
|
16
|
-
export type DocsBlockFilePropertyData = DocsBlockPropertyData<DocsBlockFilePropertyValue>;
|
|
10
|
+
export type DocsBlockFilePropertyValue = PageBlockItemFileValue["value"];
|
|
11
|
+
export type DocsBlockFilePropertyData = PageBlockItemFileValue;
|
|
17
12
|
/** File property - Definition model */
|
|
18
13
|
export type DocsBlockFilePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockFilePropertyOptions;
|
|
19
14
|
/** File property - Definition */
|
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemImageValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockImagePropertyAspectRatio } from "../../../enums/SDKDocsBlockImagePropertyAspectRatio";
|
|
3
3
|
import { DocsBlockImagePropertyWidth } from "../../../enums/SDKDocsBlockImagePropertyWidth";
|
|
4
4
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
5
|
-
import {
|
|
6
|
-
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel, DocsBlockPropertyData } from "./SDKDocsBlockProperty";
|
|
5
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
7
6
|
/** Image property - Additional non-value options */
|
|
8
7
|
export type DocsBlockImagePropertyOptions = {
|
|
9
8
|
width?: DocsBlockImagePropertyWidth;
|
|
@@ -17,13 +16,7 @@ export type DocsBlockImagePropertyOptions = {
|
|
|
17
16
|
editorInteractivity?: "edit" | "viewOnly";
|
|
18
17
|
};
|
|
19
18
|
/** Image property - Data */
|
|
20
|
-
export type DocsBlockImagePropertyData =
|
|
21
|
-
alt: string;
|
|
22
|
-
caption?: string;
|
|
23
|
-
alignment?: Alignment;
|
|
24
|
-
openLightbox?: boolean;
|
|
25
|
-
isBordered?: boolean;
|
|
26
|
-
};
|
|
19
|
+
export type DocsBlockImagePropertyData = PageBlockItemImageValue;
|
|
27
20
|
/** Image property - Definition model */
|
|
28
21
|
export type DocsBlockImagePropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockImagePropertyOptions;
|
|
29
22
|
/** Image property - Definition */
|
|
@@ -1,12 +1,13 @@
|
|
|
1
|
+
import type { PageBlockItemMarkdownValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** Markdown property - Additional non-value options */
|
|
4
5
|
export type DocsBlockMarkdownPropertyOptions = {
|
|
5
6
|
/** Defines how to validate the markdown URL */
|
|
6
7
|
urlValidationRegex?: string;
|
|
7
8
|
};
|
|
8
9
|
/** Markdown property - Data */
|
|
9
|
-
export type DocsBlockMarkdownPropertyData =
|
|
10
|
+
export type DocsBlockMarkdownPropertyData = PageBlockItemMarkdownValue;
|
|
10
11
|
/** Markdown property - Definition model */
|
|
11
12
|
export type DocsBlockMarkdownPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMarkdownPropertyOptions;
|
|
12
13
|
/** Markdown property - Definition */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemMultiRichTextValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
3
|
import { DocsBlockMultiRichTextPropertyStyle } from "../../../enums/SDKDocsBlockMultiRichTextPropertyStyle";
|
|
4
|
-
import {
|
|
4
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
5
|
/** RichText property - Additional non-value options */
|
|
6
6
|
export type DocsBlockMultiRichTextPropertyOptions = {
|
|
7
7
|
/** Placeholder to show when rich text area is empty */
|
|
@@ -10,7 +10,7 @@ export type DocsBlockMultiRichTextPropertyOptions = {
|
|
|
10
10
|
multiRichTextStyle?: DocsBlockMultiRichTextPropertyStyle;
|
|
11
11
|
};
|
|
12
12
|
/** RichText property - Data */
|
|
13
|
-
export type DocsBlockMultiRichTextPropertyData =
|
|
13
|
+
export type DocsBlockMultiRichTextPropertyData = PageBlockItemMultiRichTextValue;
|
|
14
14
|
/** RichText property - Definition model */
|
|
15
15
|
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiRichTextPropertyOptions;
|
|
16
16
|
/** RichText property - Definition */
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
import type { PageBlockItemMultiSelectValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
3
|
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
3
|
-
import {
|
|
4
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
5
|
/** MultiSelect property - Additional non-value options */
|
|
5
6
|
export type DocsBlockMultiSelectPropertyOptions = {
|
|
6
7
|
defaultChoices: Array<string>;
|
|
@@ -12,7 +13,7 @@ export type DocsBlockMultiSelectPropertyOptions = {
|
|
|
12
13
|
multiSelectStyle?: Exclude<DocsBlockOptionRenderingStyle, DocsBlockOptionRenderingStyle.toggleButton>;
|
|
13
14
|
};
|
|
14
15
|
/** MultiSelect property - Data */
|
|
15
|
-
export type DocsBlockMultiSelectPropertyData =
|
|
16
|
+
export type DocsBlockMultiSelectPropertyData = PageBlockItemMultiSelectValue;
|
|
16
17
|
/** MultiSelect property - Definition model */
|
|
17
18
|
export type DocsBlockMultiSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockMultiSelectPropertyOptions;
|
|
18
19
|
/** MultiSelect property - Definition */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import type { PageBlockItemNumberValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
|
-
import {
|
|
3
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
3
4
|
/** Number property - Additional non-value options */
|
|
4
5
|
export type DocsBlockNumberPropertyOptions = {
|
|
5
6
|
/** Default value to set when block is created */
|
|
@@ -14,7 +15,7 @@ export type DocsBlockNumberPropertyOptions = {
|
|
|
14
15
|
placeholder?: string;
|
|
15
16
|
};
|
|
16
17
|
/** Number property - Data */
|
|
17
|
-
export type DocsBlockNumberPropertyData =
|
|
18
|
+
export type DocsBlockNumberPropertyData = PageBlockItemNumberValue;
|
|
18
19
|
/** Number property - Definition model */
|
|
19
20
|
export type DocsBlockNumberPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockNumberPropertyOptions;
|
|
20
21
|
/** Number property - Definition */
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { PageBlockDefinitionProperty } from "@supernova-studio/model";
|
|
1
|
+
import type { PageBlockDefinitionProperty } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
3
|
export type DocsBlockPropertyDefinitionModel = PageBlockDefinitionProperty;
|
|
4
4
|
export type DocsBlockPropertyData<T> = {
|
|
5
5
|
value: T;
|
|
6
6
|
};
|
|
7
7
|
/** Generic property definition for when we don't care about specific types in options, just want to use the property high-level data */
|
|
8
|
-
export type DocsBlockItemPropertyAnyDefinition = DocsBlockPropertyDefinition<object, DocsBlockPropertyData<unknown
|
|
9
|
-
export declare class DocsBlockPropertyDefinition<T extends object, D extends
|
|
8
|
+
export type DocsBlockItemPropertyAnyDefinition = DocsBlockPropertyDefinition<object, Partial<DocsBlockPropertyData<unknown>>>;
|
|
9
|
+
export declare class DocsBlockPropertyDefinition<T extends object, D extends object> {
|
|
10
10
|
/** Property id, validated to be unique within a block, but not necessarily unique across all blocks */
|
|
11
11
|
id: string;
|
|
12
12
|
/** Human readable name that will show in the editor */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { PageBlockItemRichTextEditorValue } from "@supernova-studio/model";
|
|
1
|
+
import type { PageBlockItemRichTextEditorValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
3
|
import { DocsBlockRichTextEditorPropertyStyle } from "../../../enums/SDKDocsBlockRichTextEditorPropertyStyle";
|
|
4
|
-
import {
|
|
4
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
5
5
|
/** RichTextEditor property - Additional non-value options */
|
|
6
6
|
export type DocsBlockRichTextEditorPropertyOptions = {
|
|
7
7
|
/** Placeholder to show when rich text area is empty */
|
|
@@ -10,7 +10,7 @@ export type DocsBlockRichTextEditorPropertyOptions = {
|
|
|
10
10
|
allowedInlineStyles?: Array<DocsBlockRichTextEditorPropertyStyle>;
|
|
11
11
|
};
|
|
12
12
|
/** RichTextEditor property - Data */
|
|
13
|
-
export type DocsBlockRichTextEditorPropertyData =
|
|
13
|
+
export type DocsBlockRichTextEditorPropertyData = PageBlockItemRichTextEditorValue;
|
|
14
14
|
/** RichTextEditor property - Definition model */
|
|
15
15
|
export type DocsBlockRichTextEditorPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockRichTextEditorPropertyOptions;
|
|
16
16
|
/** RichTextEditor property - Definition */
|
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { PageBlockItemRichTextValue } from "@supernova-studio/model";
|
|
2
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
3
3
|
import { DocsBlockRichTextPropertyStyle } from "../../../enums/SDKDocsBlockRichTextPropertyStyle";
|
|
4
|
-
import {
|
|
5
|
-
import { DocsBlockPropertyData, DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
4
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
6
5
|
/** RichText property - Additional non-value options */
|
|
7
6
|
export type DocsBlockRichTextPropertyOptions = {
|
|
8
7
|
/** Placeholder to show when rich text area is empty */
|
|
@@ -11,10 +10,7 @@ export type DocsBlockRichTextPropertyOptions = {
|
|
|
11
10
|
richTextStyle?: DocsBlockRichTextPropertyStyle;
|
|
12
11
|
};
|
|
13
12
|
/** RichText property - Data */
|
|
14
|
-
export type DocsBlockRichTextPropertyData =
|
|
15
|
-
/** Selected token ids */
|
|
16
|
-
calloutType?: DocumentationLegacyCalloutType;
|
|
17
|
-
};
|
|
13
|
+
export type DocsBlockRichTextPropertyData = PageBlockItemRichTextValue;
|
|
18
14
|
/** RichText property - Definition model */
|
|
19
15
|
export type DocsBlockRichTextPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockRichTextPropertyOptions;
|
|
20
16
|
/** RichText property - Definition */
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import type { PageBlockItemSingleSelectValue } from "@supernova-studio/model";
|
|
1
2
|
import { DocsBlockItemPropertyType } from "../../../enums/SDKDocsBlockItemPropertyType";
|
|
2
3
|
import { DocsBlockOptionColor } from "../../../enums/SDKDocsBlockOptionColor";
|
|
3
4
|
import { DocsBlockOptionRenderingStyle } from "../../../enums/SDKDocsBlockOptionRenderStyle";
|
|
4
5
|
import { IconSet } from "../../../enums/SDKIconSet";
|
|
5
|
-
import {
|
|
6
|
+
import { DocsBlockPropertyDefinition, DocsBlockPropertyDefinitionModel } from "./SDKDocsBlockProperty";
|
|
6
7
|
/** SingleSelect property - Additional non-value options */
|
|
7
8
|
export type DocsBlockSingleSelectPropertyOptions = {
|
|
8
9
|
/** Default choices to set when block is created */
|
|
@@ -24,7 +25,7 @@ export type DocsBlockSingleSelectPropertyOptions = {
|
|
|
24
25
|
singleSelectStyle?: DocsBlockOptionRenderingStyle;
|
|
25
26
|
};
|
|
26
27
|
/** SingleSelect property - Data */
|
|
27
|
-
export type DocsBlockSingleSelectPropertyData =
|
|
28
|
+
export type DocsBlockSingleSelectPropertyData = PageBlockItemSingleSelectValue;
|
|
28
29
|
/** SingleSelect property - Definition model */
|
|
29
30
|
export type DocsBlockSingleSelectPropertyDefinitionModel = DocsBlockPropertyDefinitionModel & DocsBlockSingleSelectPropertyOptions;
|
|
30
31
|
/** SingleSelect property - Definition */
|