@supernova-studio/client 0.1.0 → 0.2.0
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/dist/index.d.mts +86 -100
- package/dist/index.d.ts +86 -100
- package/dist/index.js +257 -44
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +252 -39
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -3
- package/src/docs-editor/blocks-to-prosemirror.ts +88 -114
- package/src/docs-editor/mock.ts +2 -2
- package/src/docs-editor/prosemirror/types.ts +3 -7
- package/src/docs-editor/prosemirror-to-blocks.ts +226 -3
- package/src/docs-editor/utils.ts +14 -0
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _supernova_studio_model from '@supernova-studio/model';
|
|
2
|
-
import {
|
|
2
|
+
import { PageBlockItemUntypedPropertyValue, PageBlockDefinition, PageBlockItemV2, PageBlockItemRichTextPropertyValue, PageBlockItemMultiRichTextPropertyValue, PageBlockItemEmbedPropertyValue, PageBlockDefinitionPropertyType } from '@supernova-studio/model';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
import { Schema } from 'prosemirror-model';
|
|
5
5
|
import * as Y from 'yjs';
|
|
@@ -17,7 +17,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
17
17
|
properties: z.ZodArray<z.ZodObject<{
|
|
18
18
|
id: z.ZodString;
|
|
19
19
|
name: z.ZodString;
|
|
20
|
-
type: z.ZodEnum<["RichText", "MultiRichText", "Text", "Boolean", "Number", "SingleSelect", "MultiSelect", "Image", "Token", "TokenType", "TokenProperty", "Component", "ComponentProperty", "Asset", "AssetProperty", "EmbedURL", "URL", "Markdown", "Code", "CodeSandbox", "Table", "Divider", "Storybook"]>;
|
|
20
|
+
type: z.ZodEnum<["RichText", "MultiRichText", "Text", "Boolean", "Number", "SingleSelect", "MultiSelect", "Image", "Token", "TokenType", "TokenProperty", "Component", "ComponentProperty", "Asset", "AssetProperty", "EmbedURL", "URL", "Markdown", "Code", "CodeSandbox", "Table", "Divider", "Storybook", "Color"]>;
|
|
21
21
|
description: z.ZodOptional<z.ZodString>;
|
|
22
22
|
options: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
|
|
23
23
|
richTextStyle: z.ZodOptional<z.ZodEnum<["Title1", "Title2", "Title3", "Title4", "Title5", "Quote", "Callout", "Default"]>>;
|
|
@@ -53,7 +53,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
53
53
|
}>, z.ZodRecord<z.ZodString, z.ZodAny>>>>;
|
|
54
54
|
}, "strip", z.ZodTypeAny, {
|
|
55
55
|
id: string;
|
|
56
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
56
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
57
57
|
name: string;
|
|
58
58
|
description?: string | undefined;
|
|
59
59
|
options?: ({
|
|
@@ -70,7 +70,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
70
70
|
} & Record<string, any>> | undefined;
|
|
71
71
|
}, {
|
|
72
72
|
id: string;
|
|
73
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
73
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
74
74
|
name: string;
|
|
75
75
|
description?: string | undefined;
|
|
76
76
|
options?: ({
|
|
@@ -168,7 +168,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
168
168
|
}, "strip", z.ZodTypeAny, {
|
|
169
169
|
properties: {
|
|
170
170
|
id: string;
|
|
171
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
171
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
172
172
|
name: string;
|
|
173
173
|
description?: string | undefined;
|
|
174
174
|
options?: ({
|
|
@@ -215,7 +215,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
215
215
|
}, {
|
|
216
216
|
properties: {
|
|
217
217
|
id: string;
|
|
218
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
218
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
219
219
|
name: string;
|
|
220
220
|
description?: string | undefined;
|
|
221
221
|
options?: ({
|
|
@@ -283,7 +283,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
283
283
|
maxSelected: number;
|
|
284
284
|
}>>;
|
|
285
285
|
}, "strip", z.ZodTypeAny, {
|
|
286
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
286
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
287
287
|
items?: {
|
|
288
288
|
numberOfItems: number;
|
|
289
289
|
allowLinks: boolean;
|
|
@@ -293,7 +293,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
293
293
|
maxSelected: number;
|
|
294
294
|
} | undefined;
|
|
295
295
|
}, {
|
|
296
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
296
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
297
297
|
items?: {
|
|
298
298
|
numberOfItems: number;
|
|
299
299
|
allowLinks: boolean;
|
|
@@ -343,7 +343,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
343
343
|
name: string;
|
|
344
344
|
description: string;
|
|
345
345
|
behavior: {
|
|
346
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
346
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
347
347
|
items?: {
|
|
348
348
|
numberOfItems: number;
|
|
349
349
|
allowLinks: boolean;
|
|
@@ -357,7 +357,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
357
357
|
item: {
|
|
358
358
|
properties: {
|
|
359
359
|
id: string;
|
|
360
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
360
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
361
361
|
name: string;
|
|
362
362
|
description?: string | undefined;
|
|
363
363
|
options?: ({
|
|
@@ -421,7 +421,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
421
421
|
name: string;
|
|
422
422
|
description: string;
|
|
423
423
|
behavior: {
|
|
424
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
424
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
425
425
|
items?: {
|
|
426
426
|
numberOfItems: number;
|
|
427
427
|
allowLinks: boolean;
|
|
@@ -435,7 +435,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
435
435
|
item: {
|
|
436
436
|
properties: {
|
|
437
437
|
id: string;
|
|
438
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
438
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
439
439
|
name: string;
|
|
440
440
|
description?: string | undefined;
|
|
441
441
|
options?: ({
|
|
@@ -501,7 +501,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
501
501
|
name: string;
|
|
502
502
|
description: string;
|
|
503
503
|
behavior: {
|
|
504
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
504
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
505
505
|
items?: {
|
|
506
506
|
numberOfItems: number;
|
|
507
507
|
allowLinks: boolean;
|
|
@@ -515,7 +515,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
515
515
|
item: {
|
|
516
516
|
properties: {
|
|
517
517
|
id: string;
|
|
518
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
518
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
519
519
|
name: string;
|
|
520
520
|
description?: string | undefined;
|
|
521
521
|
options?: ({
|
|
@@ -581,7 +581,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
581
581
|
name: string;
|
|
582
582
|
description: string;
|
|
583
583
|
behavior: {
|
|
584
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
584
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
585
585
|
items?: {
|
|
586
586
|
numberOfItems: number;
|
|
587
587
|
allowLinks: boolean;
|
|
@@ -595,7 +595,7 @@ declare const GetBlockDefinitionsResponse: z.ZodObject<{
|
|
|
595
595
|
item: {
|
|
596
596
|
properties: {
|
|
597
597
|
id: string;
|
|
598
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
598
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
599
599
|
name: string;
|
|
600
600
|
description?: string | undefined;
|
|
601
601
|
options?: ({
|
|
@@ -765,24 +765,21 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
765
765
|
items: z.ZodArray<z.ZodObject<{
|
|
766
766
|
id: z.ZodString;
|
|
767
767
|
linksTo: z.ZodOptional<z.ZodObject<{
|
|
768
|
-
type: z.ZodEnum<["
|
|
769
|
-
|
|
768
|
+
type: z.ZodEnum<["DocumentationItem", "PageHeading", "Url"]>;
|
|
769
|
+
documentationItemId: z.ZodOptional<z.ZodString>;
|
|
770
770
|
pageHeadingId: z.ZodOptional<z.ZodString>;
|
|
771
|
-
groupId: z.ZodOptional<z.ZodString>;
|
|
772
771
|
url: z.ZodOptional<z.ZodString>;
|
|
773
772
|
openInNewTab: z.ZodOptional<z.ZodBoolean>;
|
|
774
773
|
}, "strip", z.ZodTypeAny, {
|
|
775
|
-
type: "
|
|
776
|
-
|
|
774
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
775
|
+
documentationItemId?: string | undefined;
|
|
777
776
|
pageHeadingId?: string | undefined;
|
|
778
|
-
groupId?: string | undefined;
|
|
779
777
|
url?: string | undefined;
|
|
780
778
|
openInNewTab?: boolean | undefined;
|
|
781
779
|
}, {
|
|
782
|
-
type: "
|
|
783
|
-
|
|
780
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
781
|
+
documentationItemId?: string | undefined;
|
|
784
782
|
pageHeadingId?: string | undefined;
|
|
785
|
-
groupId?: string | undefined;
|
|
786
783
|
url?: string | undefined;
|
|
787
784
|
openInNewTab?: boolean | undefined;
|
|
788
785
|
}>>;
|
|
@@ -799,10 +796,9 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
799
796
|
value?: any;
|
|
800
797
|
} & Record<string, any>>;
|
|
801
798
|
linksTo?: {
|
|
802
|
-
type: "
|
|
803
|
-
|
|
799
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
800
|
+
documentationItemId?: string | undefined;
|
|
804
801
|
pageHeadingId?: string | undefined;
|
|
805
|
-
groupId?: string | undefined;
|
|
806
802
|
url?: string | undefined;
|
|
807
803
|
openInNewTab?: boolean | undefined;
|
|
808
804
|
} | undefined;
|
|
@@ -812,10 +808,9 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
812
808
|
value?: any;
|
|
813
809
|
} & Record<string, any>>;
|
|
814
810
|
linksTo?: {
|
|
815
|
-
type: "
|
|
816
|
-
|
|
811
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
812
|
+
documentationItemId?: string | undefined;
|
|
817
813
|
pageHeadingId?: string | undefined;
|
|
818
|
-
groupId?: string | undefined;
|
|
819
814
|
url?: string | undefined;
|
|
820
815
|
openInNewTab?: boolean | undefined;
|
|
821
816
|
} | undefined;
|
|
@@ -829,10 +824,9 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
829
824
|
value?: any;
|
|
830
825
|
} & Record<string, any>>;
|
|
831
826
|
linksTo?: {
|
|
832
|
-
type: "
|
|
833
|
-
|
|
827
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
828
|
+
documentationItemId?: string | undefined;
|
|
834
829
|
pageHeadingId?: string | undefined;
|
|
835
|
-
groupId?: string | undefined;
|
|
836
830
|
url?: string | undefined;
|
|
837
831
|
openInNewTab?: boolean | undefined;
|
|
838
832
|
} | undefined;
|
|
@@ -863,10 +857,9 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
863
857
|
value?: any;
|
|
864
858
|
} & Record<string, any>>;
|
|
865
859
|
linksTo?: {
|
|
866
|
-
type: "
|
|
867
|
-
|
|
860
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
861
|
+
documentationItemId?: string | undefined;
|
|
868
862
|
pageHeadingId?: string | undefined;
|
|
869
|
-
groupId?: string | undefined;
|
|
870
863
|
url?: string | undefined;
|
|
871
864
|
openInNewTab?: boolean | undefined;
|
|
872
865
|
} | undefined;
|
|
@@ -900,10 +893,9 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
900
893
|
value?: any;
|
|
901
894
|
} & Record<string, any>>;
|
|
902
895
|
linksTo?: {
|
|
903
|
-
type: "
|
|
904
|
-
|
|
896
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
897
|
+
documentationItemId?: string | undefined;
|
|
905
898
|
pageHeadingId?: string | undefined;
|
|
906
|
-
groupId?: string | undefined;
|
|
907
899
|
url?: string | undefined;
|
|
908
900
|
openInNewTab?: boolean | undefined;
|
|
909
901
|
} | undefined;
|
|
@@ -937,10 +929,9 @@ declare const PageBlockEditorModel: z.ZodObject<{
|
|
|
937
929
|
value?: any;
|
|
938
930
|
} & Record<string, any>>;
|
|
939
931
|
linksTo?: {
|
|
940
|
-
type: "
|
|
941
|
-
|
|
932
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
933
|
+
documentationItemId?: string | undefined;
|
|
942
934
|
pageHeadingId?: string | undefined;
|
|
943
|
-
groupId?: string | undefined;
|
|
944
935
|
url?: string | undefined;
|
|
945
936
|
openInNewTab?: boolean | undefined;
|
|
946
937
|
} | undefined;
|
|
@@ -1074,24 +1065,21 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1074
1065
|
items: z.ZodArray<z.ZodObject<{
|
|
1075
1066
|
id: z.ZodString;
|
|
1076
1067
|
linksTo: z.ZodOptional<z.ZodObject<{
|
|
1077
|
-
type: z.ZodEnum<["
|
|
1078
|
-
|
|
1068
|
+
type: z.ZodEnum<["DocumentationItem", "PageHeading", "Url"]>;
|
|
1069
|
+
documentationItemId: z.ZodOptional<z.ZodString>;
|
|
1079
1070
|
pageHeadingId: z.ZodOptional<z.ZodString>;
|
|
1080
|
-
groupId: z.ZodOptional<z.ZodString>;
|
|
1081
1071
|
url: z.ZodOptional<z.ZodString>;
|
|
1082
1072
|
openInNewTab: z.ZodOptional<z.ZodBoolean>;
|
|
1083
1073
|
}, "strip", z.ZodTypeAny, {
|
|
1084
|
-
type: "
|
|
1085
|
-
|
|
1074
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1075
|
+
documentationItemId?: string | undefined;
|
|
1086
1076
|
pageHeadingId?: string | undefined;
|
|
1087
|
-
groupId?: string | undefined;
|
|
1088
1077
|
url?: string | undefined;
|
|
1089
1078
|
openInNewTab?: boolean | undefined;
|
|
1090
1079
|
}, {
|
|
1091
|
-
type: "
|
|
1092
|
-
|
|
1080
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1081
|
+
documentationItemId?: string | undefined;
|
|
1093
1082
|
pageHeadingId?: string | undefined;
|
|
1094
|
-
groupId?: string | undefined;
|
|
1095
1083
|
url?: string | undefined;
|
|
1096
1084
|
openInNewTab?: boolean | undefined;
|
|
1097
1085
|
}>>;
|
|
@@ -1108,10 +1096,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1108
1096
|
value?: any;
|
|
1109
1097
|
} & Record<string, any>>;
|
|
1110
1098
|
linksTo?: {
|
|
1111
|
-
type: "
|
|
1112
|
-
|
|
1099
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1100
|
+
documentationItemId?: string | undefined;
|
|
1113
1101
|
pageHeadingId?: string | undefined;
|
|
1114
|
-
groupId?: string | undefined;
|
|
1115
1102
|
url?: string | undefined;
|
|
1116
1103
|
openInNewTab?: boolean | undefined;
|
|
1117
1104
|
} | undefined;
|
|
@@ -1121,10 +1108,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1121
1108
|
value?: any;
|
|
1122
1109
|
} & Record<string, any>>;
|
|
1123
1110
|
linksTo?: {
|
|
1124
|
-
type: "
|
|
1125
|
-
|
|
1111
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1112
|
+
documentationItemId?: string | undefined;
|
|
1126
1113
|
pageHeadingId?: string | undefined;
|
|
1127
|
-
groupId?: string | undefined;
|
|
1128
1114
|
url?: string | undefined;
|
|
1129
1115
|
openInNewTab?: boolean | undefined;
|
|
1130
1116
|
} | undefined;
|
|
@@ -1138,10 +1124,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1138
1124
|
value?: any;
|
|
1139
1125
|
} & Record<string, any>>;
|
|
1140
1126
|
linksTo?: {
|
|
1141
|
-
type: "
|
|
1142
|
-
|
|
1127
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1128
|
+
documentationItemId?: string | undefined;
|
|
1143
1129
|
pageHeadingId?: string | undefined;
|
|
1144
|
-
groupId?: string | undefined;
|
|
1145
1130
|
url?: string | undefined;
|
|
1146
1131
|
openInNewTab?: boolean | undefined;
|
|
1147
1132
|
} | undefined;
|
|
@@ -1172,10 +1157,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1172
1157
|
value?: any;
|
|
1173
1158
|
} & Record<string, any>>;
|
|
1174
1159
|
linksTo?: {
|
|
1175
|
-
type: "
|
|
1176
|
-
|
|
1160
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1161
|
+
documentationItemId?: string | undefined;
|
|
1177
1162
|
pageHeadingId?: string | undefined;
|
|
1178
|
-
groupId?: string | undefined;
|
|
1179
1163
|
url?: string | undefined;
|
|
1180
1164
|
openInNewTab?: boolean | undefined;
|
|
1181
1165
|
} | undefined;
|
|
@@ -1209,10 +1193,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1209
1193
|
value?: any;
|
|
1210
1194
|
} & Record<string, any>>;
|
|
1211
1195
|
linksTo?: {
|
|
1212
|
-
type: "
|
|
1213
|
-
|
|
1196
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1197
|
+
documentationItemId?: string | undefined;
|
|
1214
1198
|
pageHeadingId?: string | undefined;
|
|
1215
|
-
groupId?: string | undefined;
|
|
1216
1199
|
url?: string | undefined;
|
|
1217
1200
|
openInNewTab?: boolean | undefined;
|
|
1218
1201
|
} | undefined;
|
|
@@ -1246,10 +1229,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1246
1229
|
value?: any;
|
|
1247
1230
|
} & Record<string, any>>;
|
|
1248
1231
|
linksTo?: {
|
|
1249
|
-
type: "
|
|
1250
|
-
|
|
1232
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1233
|
+
documentationItemId?: string | undefined;
|
|
1251
1234
|
pageHeadingId?: string | undefined;
|
|
1252
|
-
groupId?: string | undefined;
|
|
1253
1235
|
url?: string | undefined;
|
|
1254
1236
|
openInNewTab?: boolean | undefined;
|
|
1255
1237
|
} | undefined;
|
|
@@ -1285,10 +1267,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1285
1267
|
value?: any;
|
|
1286
1268
|
} & Record<string, any>>;
|
|
1287
1269
|
linksTo?: {
|
|
1288
|
-
type: "
|
|
1289
|
-
|
|
1270
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1271
|
+
documentationItemId?: string | undefined;
|
|
1290
1272
|
pageHeadingId?: string | undefined;
|
|
1291
|
-
groupId?: string | undefined;
|
|
1292
1273
|
url?: string | undefined;
|
|
1293
1274
|
openInNewTab?: boolean | undefined;
|
|
1294
1275
|
} | undefined;
|
|
@@ -1324,10 +1305,9 @@ declare const DocumentationPageEditorModel: z.ZodObject<{
|
|
|
1324
1305
|
value?: any;
|
|
1325
1306
|
} & Record<string, any>>;
|
|
1326
1307
|
linksTo?: {
|
|
1327
|
-
type: "
|
|
1328
|
-
|
|
1308
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1309
|
+
documentationItemId?: string | undefined;
|
|
1329
1310
|
pageHeadingId?: string | undefined;
|
|
1330
|
-
groupId?: string | undefined;
|
|
1331
1311
|
url?: string | undefined;
|
|
1332
1312
|
openInNewTab?: boolean | undefined;
|
|
1333
1313
|
} | undefined;
|
|
@@ -1368,20 +1348,10 @@ type ProsemirrorMark = {
|
|
|
1368
1348
|
attrs: Record<string, any>;
|
|
1369
1349
|
};
|
|
1370
1350
|
type ProsemirrorBlockItem = {
|
|
1371
|
-
properties: ProsemirrorBlockItemPropertyValue[];
|
|
1372
|
-
};
|
|
1373
|
-
type ProsemirrorBlockItemPropertyValue = {
|
|
1374
1351
|
id: string;
|
|
1375
|
-
|
|
1376
|
-
value?: string;
|
|
1377
|
-
};
|
|
1352
|
+
props: Record<string, PageBlockItemUntypedPropertyValue>;
|
|
1378
1353
|
};
|
|
1379
1354
|
|
|
1380
|
-
type Input = {
|
|
1381
|
-
block: PageBlockEditorModel;
|
|
1382
|
-
definition: PageBlockDefinition;
|
|
1383
|
-
property: PageBlockDefinitionProperty;
|
|
1384
|
-
};
|
|
1385
1355
|
declare function pageToYXmlFragment(page: DocumentationPageEditorModel, definitions: PageBlockDefinition[], fragment: Y.XmlFragment): Y.XmlFragment;
|
|
1386
1356
|
declare function pageToProsemirrorDoc(page: DocumentationPageEditorModel, definitions: PageBlockDefinition[]): ProsemirrorNode;
|
|
1387
1357
|
declare function blockDefinitionForBlock(block: PageBlockEditorModel, definitions: PageBlockDefinition[]): {
|
|
@@ -1389,7 +1359,7 @@ declare function blockDefinitionForBlock(block: PageBlockEditorModel, definition
|
|
|
1389
1359
|
name: string;
|
|
1390
1360
|
description: string;
|
|
1391
1361
|
behavior: {
|
|
1392
|
-
dataType: "Component" | "Token" | "Asset" | "
|
|
1362
|
+
dataType: "Component" | "Token" | "Asset" | "FigmaFrame" | "Item";
|
|
1393
1363
|
items?: {
|
|
1394
1364
|
numberOfItems: number;
|
|
1395
1365
|
allowLinks: boolean;
|
|
@@ -1403,7 +1373,7 @@ declare function blockDefinitionForBlock(block: PageBlockEditorModel, definition
|
|
|
1403
1373
|
item: {
|
|
1404
1374
|
properties: {
|
|
1405
1375
|
id: string;
|
|
1406
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
1376
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1407
1377
|
name: string;
|
|
1408
1378
|
description?: string | undefined;
|
|
1409
1379
|
options?: ({
|
|
@@ -1464,8 +1434,6 @@ declare function blockDefinitionForBlock(block: PageBlockEditorModel, definition
|
|
|
1464
1434
|
} | undefined;
|
|
1465
1435
|
};
|
|
1466
1436
|
declare function blockToProsemirrorNode(block: PageBlockEditorModel, definition: PageBlockDefinition): ProsemirrorNode | null;
|
|
1467
|
-
declare function serializeAsRichTextBlock(input: Input): ProsemirrorNode;
|
|
1468
|
-
declare function serializeAsMultiRichTextBlock(input: Input): ProsemirrorNode;
|
|
1469
1437
|
declare function serializeAsCustomBlock(block: PageBlockEditorModel, definition: PageBlockDefinition): ProsemirrorNode;
|
|
1470
1438
|
|
|
1471
1439
|
declare function getMockPageBlockDefinitions(): PageBlockDefinition[];
|
|
@@ -1481,16 +1449,16 @@ declare const BlockParsingUtils: {
|
|
|
1481
1449
|
value?: any;
|
|
1482
1450
|
} & Record<string, any>>;
|
|
1483
1451
|
linksTo?: {
|
|
1484
|
-
type: "
|
|
1485
|
-
|
|
1452
|
+
type: "DocumentationItem" | "PageHeading" | "Url";
|
|
1453
|
+
documentationItemId?: string | undefined;
|
|
1486
1454
|
pageHeadingId?: string | undefined;
|
|
1487
|
-
groupId?: string | undefined;
|
|
1488
1455
|
url?: string | undefined;
|
|
1489
1456
|
openInNewTab?: boolean | undefined;
|
|
1490
1457
|
} | undefined;
|
|
1491
1458
|
};
|
|
1492
1459
|
richTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemRichTextPropertyValue;
|
|
1493
1460
|
multiRichTextPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemMultiRichTextPropertyValue;
|
|
1461
|
+
embedPropertyValue(item: PageBlockItemV2, propertyKey: string): PageBlockItemEmbedPropertyValue;
|
|
1494
1462
|
objectPropertyValue(item: PageBlockItemV2, propertyKey: string): {
|
|
1495
1463
|
value?: any;
|
|
1496
1464
|
} & Record<string, any>;
|
|
@@ -1499,7 +1467,7 @@ declare const BlockParsingUtils: {
|
|
|
1499
1467
|
declare const BlockDefinitionUtils: {
|
|
1500
1468
|
firstRichTextProperty(definition: PageBlockDefinition): {
|
|
1501
1469
|
id: string;
|
|
1502
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
1470
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1503
1471
|
name: string;
|
|
1504
1472
|
description?: string | undefined;
|
|
1505
1473
|
options?: ({
|
|
@@ -1517,7 +1485,7 @@ declare const BlockDefinitionUtils: {
|
|
|
1517
1485
|
} | undefined;
|
|
1518
1486
|
firstMultiRichTextProperty(definition: PageBlockDefinition): {
|
|
1519
1487
|
id: string;
|
|
1520
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
1488
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1521
1489
|
name: string;
|
|
1522
1490
|
description?: string | undefined;
|
|
1523
1491
|
options?: ({
|
|
@@ -1535,7 +1503,25 @@ declare const BlockDefinitionUtils: {
|
|
|
1535
1503
|
} | undefined;
|
|
1536
1504
|
firstTableProperty(definition: PageBlockDefinition): {
|
|
1537
1505
|
id: string;
|
|
1538
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
1506
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1507
|
+
name: string;
|
|
1508
|
+
description?: string | undefined;
|
|
1509
|
+
options?: ({
|
|
1510
|
+
richTextStyle?: "Quote" | "Callout" | "Title1" | "Title2" | "Title3" | "Title4" | "Title5" | "Default" | undefined;
|
|
1511
|
+
multiRichTextStyle?: "Default" | "OL" | "UL" | undefined;
|
|
1512
|
+
textStyle?: "Small" | "Title1" | "Title2" | "Title3" | "Title4" | "Title5" | "Default" | "DefaultBold" | "DefaultSemibold" | "SmallBold" | "SmallSemibold" | undefined;
|
|
1513
|
+
placeholder?: string | undefined;
|
|
1514
|
+
} & Record<string, any>) | undefined;
|
|
1515
|
+
variantOptions?: Record<string, {
|
|
1516
|
+
richTextStyle?: "Quote" | "Callout" | "Title1" | "Title2" | "Title3" | "Title4" | "Title5" | "Default" | undefined;
|
|
1517
|
+
multiRichTextStyle?: "Default" | "OL" | "UL" | undefined;
|
|
1518
|
+
textStyle?: "Small" | "Title1" | "Title2" | "Title3" | "Title4" | "Title5" | "Default" | "DefaultBold" | "DefaultSemibold" | "SmallBold" | "SmallSemibold" | undefined;
|
|
1519
|
+
placeholder?: string | undefined;
|
|
1520
|
+
} & Record<string, any>> | undefined;
|
|
1521
|
+
} | undefined;
|
|
1522
|
+
firstEmbedProperty(definition: PageBlockDefinition): {
|
|
1523
|
+
id: string;
|
|
1524
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1539
1525
|
name: string;
|
|
1540
1526
|
description?: string | undefined;
|
|
1541
1527
|
options?: ({
|
|
@@ -1553,7 +1539,7 @@ declare const BlockDefinitionUtils: {
|
|
|
1553
1539
|
} | undefined;
|
|
1554
1540
|
richTextProperty(definition: PageBlockDefinition, propertyKey: string): {
|
|
1555
1541
|
id: string;
|
|
1556
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
1542
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1557
1543
|
name: string;
|
|
1558
1544
|
description?: string | undefined;
|
|
1559
1545
|
options?: ({
|
|
@@ -1571,7 +1557,7 @@ declare const BlockDefinitionUtils: {
|
|
|
1571
1557
|
};
|
|
1572
1558
|
property(definition: PageBlockDefinition, propertyKey: string, expectedPropertyType?: PageBlockDefinitionPropertyType): {
|
|
1573
1559
|
id: string;
|
|
1574
|
-
type: "Image" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "
|
|
1560
|
+
type: "Image" | "Color" | "Component" | "Token" | "Text" | "Number" | "Boolean" | "URL" | "Code" | "Divider" | "Table" | "Markdown" | "Asset" | "RichText" | "MultiRichText" | "SingleSelect" | "MultiSelect" | "TokenType" | "TokenProperty" | "ComponentProperty" | "AssetProperty" | "EmbedURL" | "CodeSandbox" | "Storybook";
|
|
1575
1561
|
name: string;
|
|
1576
1562
|
description?: string | undefined;
|
|
1577
1563
|
options?: ({
|
|
@@ -1589,4 +1575,4 @@ declare const BlockDefinitionUtils: {
|
|
|
1589
1575
|
};
|
|
1590
1576
|
};
|
|
1591
1577
|
|
|
1592
|
-
export { BlockDefinitionUtils, BlockParsingUtils, DocumentationPageEditorModel, GetBlockDefinitionsResponse, PageBlockEditorModel, type ProsemirrorBlockItem, type
|
|
1578
|
+
export { BlockDefinitionUtils, BlockParsingUtils, DocumentationPageEditorModel, GetBlockDefinitionsResponse, PageBlockEditorModel, type ProsemirrorBlockItem, type ProsemirrorMark, type ProsemirrorNode, blockDefinitionForBlock, blockToProsemirrorNode, getMockPageBlockDefinitions, pageToProsemirrorDoc, pageToYXmlFragment, pmSchema, prosemirrorDocToPage, prosemirrorNodeToBlock, serializeAsCustomBlock, yXmlFragmetToPage };
|