@prismicio/editor-fields 0.1.0-rc.4 → 0.1.0-rc.6

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.
Files changed (89) hide show
  1. package/dist/DocumentEditor.d.ts +1 -1
  2. package/dist/domain/Field.d.ts +6 -5
  3. package/dist/domain/Group.d.ts +3 -2
  4. package/dist/domain/fields/ImageField/ExternalImage.d.ts +23 -0
  5. package/dist/domain/fields/ImageField/ImageField.d.ts +11 -0
  6. package/dist/domain/slices/SharedSlice.d.ts +1 -1
  7. package/dist/domain/zones/RepeatableZone.d.ts +2 -3
  8. package/dist/fields/ImageField/ImageField.d.ts +12 -0
  9. package/dist/fields/ImageField/MediaPicker/MediaPicker.d.ts +8 -0
  10. package/dist/fields/ImageField/MediaPicker/index.d.ts +1 -0
  11. package/dist/fields/ImageField/MediaPicker/unsplashData.d.ts +115 -0
  12. package/dist/fields/ImageField/index.d.ts +1 -0
  13. package/dist/fields/RichTextField/coreExtensions/ListItem.d.ts +6 -6
  14. package/dist/fields/RichTextField/extensions/index.d.ts +1 -1
  15. package/dist/fields/RichTextField/models/MenuItems.d.ts +2 -2
  16. package/dist/index.es.js +25332 -22687
  17. package/dist/index.umd.js +35 -34
  18. package/dist/slices/SharedSliceEditor.d.ts +2 -2
  19. package/dist/zones/RepeatableZoneEditor.d.ts +1 -1
  20. package/package.json +7 -6
  21. package/dist/domain/__tests__/Document.test.d.ts +0 -1
  22. package/dist/fields/NestableField.d.ts +0 -12
  23. package/dist/fields/RichTextField/MenuBar/MenuBar.d.ts +0 -9
  24. package/dist/fields/RichTextField/MenuBar/MenuItem.d.ts +0 -10
  25. package/dist/fields/RichTextField/MenuBar/index.d.ts +0 -2
  26. package/dist/fields/RichTextField/core-extensions/Document.d.ts +0 -3
  27. package/dist/fields/RichTextField/core-extensions/HardBreak.d.ts +0 -11
  28. package/dist/fields/RichTextField/core-extensions/ListItem.d.ts +0 -44
  29. package/dist/fields/RichTextField/core-extensions/Text.d.ts +0 -15
  30. package/dist/fields/RichTextField/core-extensions/index.d.ts +0 -95
  31. package/dist/fields/RichTextField/global-extensions/TextDirection.d.ts +0 -38
  32. package/dist/fields/RichTextField/global-extensions/index.d.ts +0 -3
  33. package/dist/fields/RichTextField/models/Block.d.ts +0 -5
  34. package/dist/fields/RichTextField/models/helpers/Arrays.d.ts +0 -1
  35. package/dist/fields/RichTextField/models/helpers/DOMParser.d.ts +0 -1
  36. package/dist/fields/RichTextField/models/helpers/Objects.d.ts +0 -3
  37. package/dist/fields/index.d.ts +0 -182
  38. package/dist/fields/nestable/BooleanField.d.ts +0 -12
  39. package/dist/fields/nestable/ColorField.d.ts +0 -11
  40. package/dist/fields/nestable/DateField.d.ts +0 -12
  41. package/dist/fields/nestable/Field.d.ts +0 -40
  42. package/dist/fields/nestable/GeoField.d.ts +0 -16
  43. package/dist/fields/nestable/ImageField/ImageEditor.d.ts +0 -11
  44. package/dist/fields/nestable/ImageField/ImageField.d.ts +0 -70
  45. package/dist/fields/nestable/ImageField/ImageSelector.d.ts +0 -5
  46. package/dist/fields/nestable/ImageField/config.d.ts +0 -1
  47. package/dist/fields/nestable/ImageField/models/EditImage.d.ts +0 -27
  48. package/dist/fields/nestable/ImageField/models/ExternalImage.d.ts +0 -32
  49. package/dist/fields/nestable/ImageField/models/providers/UnsplashProvider.d.ts +0 -6
  50. package/dist/fields/nestable/KeyTextField.d.ts +0 -12
  51. package/dist/fields/nestable/NumberField.d.ts +0 -14
  52. package/dist/fields/nestable/RangeField.d.ts +0 -14
  53. package/dist/fields/nestable/RichTextField/MenuBar/MenuBar.d.ts +0 -9
  54. package/dist/fields/nestable/RichTextField/MenuBar/MenuItem.d.ts +0 -10
  55. package/dist/fields/nestable/RichTextField/MenuBar/index.d.ts +0 -2
  56. package/dist/fields/nestable/RichTextField/RichTextField.d.ts +0 -21
  57. package/dist/fields/nestable/RichTextField/coreExtensions/Document.d.ts +0 -3
  58. package/dist/fields/nestable/RichTextField/coreExtensions/HardBreak.d.ts +0 -12
  59. package/dist/fields/nestable/RichTextField/coreExtensions/ListItem.d.ts +0 -43
  60. package/dist/fields/nestable/RichTextField/coreExtensions/Text.d.ts +0 -15
  61. package/dist/fields/nestable/RichTextField/coreExtensions/index.d.ts +0 -8
  62. package/dist/fields/nestable/RichTextField/extensions/Bold.d.ts +0 -3
  63. package/dist/fields/nestable/RichTextField/extensions/BulletList.d.ts +0 -3
  64. package/dist/fields/nestable/RichTextField/extensions/CodeBlock.d.ts +0 -3
  65. package/dist/fields/nestable/RichTextField/extensions/Embed/EmbedView.d.ts +0 -3
  66. package/dist/fields/nestable/RichTextField/extensions/Embed/index.d.ts +0 -10
  67. package/dist/fields/nestable/RichTextField/extensions/Heading.d.ts +0 -18
  68. package/dist/fields/nestable/RichTextField/extensions/Italic.d.ts +0 -3
  69. package/dist/fields/nestable/RichTextField/extensions/Link.d.ts +0 -4
  70. package/dist/fields/nestable/RichTextField/extensions/OrderedList.d.ts +0 -3
  71. package/dist/fields/nestable/RichTextField/extensions/Paragraph.d.ts +0 -3
  72. package/dist/fields/nestable/RichTextField/extensions/index.d.ts +0 -14
  73. package/dist/fields/nestable/RichTextField/globalExtensions/TextDirection.d.ts +0 -39
  74. package/dist/fields/nestable/RichTextField/globalExtensions/index.d.ts +0 -1
  75. package/dist/fields/nestable/RichTextField/index.d.ts +0 -1
  76. package/dist/fields/nestable/RichTextField/models/EditorExtension.d.ts +0 -105
  77. package/dist/fields/nestable/RichTextField/models/RichTextConfig.d.ts +0 -10
  78. package/dist/fields/nestable/RichTextField/models/Span.d.ts +0 -12
  79. package/dist/fields/nestable/RichTextField/models/helpers/DOMParser.d.ts +0 -1
  80. package/dist/fields/nestable/RichTextField/models/helpers/NodeUtils.d.ts +0 -14
  81. package/dist/fields/nestable/RichTextField/models/helpers/index.d.ts +0 -2
  82. package/dist/fields/nestable/RichTextField/models/index.d.ts +0 -3
  83. package/dist/fields/nestable/SelectField.d.ts +0 -13
  84. package/dist/fields/nestable/SeparatorField.d.ts +0 -9
  85. package/dist/fields/nestable/TimestampField.d.ts +0 -12
  86. package/dist/fields/nestable/index.d.ts +0 -182
  87. package/dist/style.css +0 -1
  88. package/dist/utils/HttpClient.d.ts +0 -18
  89. package/dist/utils/useDebounceState.d.ts +0 -1
@@ -6,7 +6,7 @@ declare type DocumentEditorProps = Readonly<{
6
6
  content: DocumentContent;
7
7
  customType: DynamicCustomType;
8
8
  onContentChange: (content: DocumentContent) => void;
9
- readOnly?: boolean | undefined;
9
+ readOnly?: boolean;
10
10
  sectionName: string | undefined;
11
11
  sharedSlices: SharedSlices;
12
12
  }>;
@@ -1,5 +1,6 @@
1
- import { Group } from "@prismicio/types-internal/lib/customtypes/widgets";
2
- import type { BooleanField, NestableWidget, Separator } from "@prismicio/types-internal/lib/customtypes/widgets/nestable";
3
- export declare function getFieldLabel(field: NestableWidget | Group): string;
4
- export declare function getFieldPlaceholder(field: Exclude<NestableWidget, Separator | BooleanField>): string;
5
- export declare function getFieldPlaceholder(field: BooleanField, value: boolean): string;
1
+ import type { BooleanField as BooleanT, NestableWidget, Separator } from "@prismicio/types-internal/lib/customtypes/widgets/nestable";
2
+ declare type Field = Exclude<NestableWidget, Separator>;
3
+ export declare function getFieldLabel(field: Field | Separator): string;
4
+ export declare function getFieldPlaceholder(field: Exclude<Field, BooleanT>): string;
5
+ export declare function getFieldPlaceholder(field: BooleanT, value: boolean): string;
6
+ export {};
@@ -1,6 +1,7 @@
1
1
  import type { Group } from "@prismicio/types-internal/lib/customtypes/widgets";
2
- import { GroupContent, GroupItemContent } from "@prismicio/types-internal/lib/documents/widgets";
2
+ import { GroupContent, GroupItemContent, SimpleWidgetContent } from "@prismicio/types-internal/lib/documents/widgets";
3
3
  import type { RepeatableZone } from "./zones/RepeatableZone";
4
+ export declare function getGroupLabel(group: Group): string;
4
5
  export declare function getRepeatableZone(group: Group): RepeatableZone;
5
6
  export declare function updateRepeatableZoneContent(groupContent: GroupContent | undefined, repeatableZoneContent: GroupItemContent[]): GroupContent;
6
- export declare const emptyGroupItemContent: () => GroupItemContent;
7
+ export declare const createGroupItemContent: (value?: [string, SimpleWidgetContent][]) => GroupItemContent;
@@ -0,0 +1,23 @@
1
+ import type { Image } from "@prismicio/types-internal/lib/customtypes/widgets/nestable";
2
+ import type { ImageConstraint } from "@prismicio/types-internal/lib/customtypes/widgets/shared";
3
+ import type { ImageContentO as ImageContent } from "@prismicio/types-internal/lib/documents/widgets/nestable";
4
+ export interface ExternalImage {
5
+ id: string;
6
+ url: string;
7
+ width: number;
8
+ height: number;
9
+ }
10
+ export declare function replaceImage(thumbnailName: string, field: Image, content: ImageContent | undefined, extImage: ExternalImage): ImageContent;
11
+ export declare function fitImage(extImage: {
12
+ width: number;
13
+ height: number;
14
+ }, constraints?: ImageConstraint): {
15
+ width: number;
16
+ height: number;
17
+ rect: {
18
+ x: number;
19
+ y: number;
20
+ width: number;
21
+ height: number;
22
+ };
23
+ };
@@ -0,0 +1,11 @@
1
+ import type { Image } from "@prismicio/types-internal/lib/customtypes/widgets/nestable";
2
+ import type { ImageConstraint } from "@prismicio/types-internal/lib/customtypes/widgets/shared";
3
+ import type { ImageContentO as ImageContent, ImageContentView } from "@prismicio/types-internal/lib/documents/widgets/nestable";
4
+ export declare type Thumbnail = Readonly<ImageConstraint & {
5
+ name: string;
6
+ }>;
7
+ export declare const MAIN_THUMBNAIL_NAME = "main";
8
+ export declare function getImageLabel(thumbnail: Thumbnail, content: ImageContent | undefined, contentView: ImageContentView | undefined): readonly [thumbnailName: string | undefined, size: string | undefined];
9
+ export declare function getImageThumbnails(field: Image): readonly Thumbnail[];
10
+ export declare function getImageContentViews(field: Image, content: ImageContent): readonly [ImageContentView, ...(ImageContentView | undefined)[]];
11
+ export declare function updateImageContentAlt(thumbnailName: string, content: ImageContent, contentView: ImageContentView, value: string): ImageContent;
@@ -4,6 +4,6 @@ import type { NonRepeatableZone } from "../zones/NonRepeatableZone";
4
4
  import type { RepeatableZone } from "../zones/RepeatableZone";
5
5
  export declare function defaultSharedSliceContent(variationId: string): SharedSliceContent;
6
6
  export declare function getVariation(sharedSlice: SharedSlice, variationId: string): Variation | undefined;
7
- export declare function getSharedSliceLegend(sharedSlice: SharedSlice, variation: Variation): string;
7
+ export declare function getSharedSliceLegend(sharedSlice: SharedSlice, variation: Variation): readonly [sharedSliceName: string, variationName: string];
8
8
  export declare function getNonRepeatableZone(variation: Variation): NonRepeatableZone;
9
9
  export declare function getRepeatableZone(variation: Variation): RepeatableZone;
@@ -1,7 +1,6 @@
1
1
  import type { NestableWidget } from "@prismicio/types-internal/lib/customtypes/widgets/nestable";
2
2
  import type { GroupItemContent, SimpleWidgetContent } from "@prismicio/types-internal/lib/documents/widgets";
3
- import type { NestableWidgetContent } from "../NestableWidget";
4
3
  export declare type RepeatableZone = Readonly<Partial<Record<string, NestableWidget>>>;
5
4
  export declare function defaultRepeatableZoneContentIfUndefined(repeatableZoneContent: GroupItemContent[] | undefined): GroupItemContent[];
6
- export declare function getGroupItemContentValue(groupItemContent: GroupItemContent): Readonly<Partial<Record<string, SimpleWidgetContent>>>;
7
- export declare function updateRepeatableWidgetContent(repeatableZoneContent: GroupItemContent[], groupItemContentIndex: number, repeatableWidgetIndex: number, repeatableWidgetId: string, repeatableWidgetContent: NestableWidgetContent | undefined): GroupItemContent[];
5
+ export declare function updateRepeatableZone(repeatableZoneContent: GroupItemContent[], updatedItemWithIndex: [number, GroupItemContent | undefined]): GroupItemContent[];
6
+ export declare function updateRepeatableZoneItem(repeatableItemContent: GroupItemContent, updatedWidgetWithId: [string, SimpleWidgetContent | undefined]): GroupItemContent;
@@ -0,0 +1,12 @@
1
+ import type { Image } from "@prismicio/types-internal/lib/customtypes/widgets/nestable";
2
+ import type { ImageContentO as ImageContent } from "@prismicio/types-internal/lib/documents/widgets/nestable";
3
+ import { type FC } from "react";
4
+ declare type ImageFieldProps = Readonly<{
5
+ content: ImageContent | undefined;
6
+ field: Image;
7
+ id: string;
8
+ onContentChange: (content: ImageContent | undefined) => void;
9
+ readOnly: boolean;
10
+ }>;
11
+ export declare const ImageField: FC<ImageFieldProps>;
12
+ export {};
@@ -0,0 +1,8 @@
1
+ import { FC, ReactNode } from "react";
2
+ import type { ExternalImage } from "../../../domain/fields/ImageField/ExternalImage";
3
+ interface MediaPickerProps {
4
+ trigger: ReactNode;
5
+ onMediaSelected?: (media: ExternalImage) => void;
6
+ }
7
+ export declare const MediaPicker: FC<MediaPickerProps>;
8
+ export {};
@@ -0,0 +1 @@
1
+ export { MediaPicker } from "./MediaPicker";
@@ -0,0 +1,115 @@
1
+ import { TypeOf } from "zod";
2
+ declare const unsplashImage: import("zod").ZodObject<{
3
+ id: import("zod").ZodString;
4
+ width: import("zod").ZodNumber;
5
+ height: import("zod").ZodNumber;
6
+ urls: import("zod").ZodObject<{
7
+ full: import("zod").ZodString;
8
+ small: import("zod").ZodString;
9
+ }, "strip", import("zod").ZodTypeAny, {
10
+ small: string;
11
+ full: string;
12
+ }, {
13
+ small: string;
14
+ full: string;
15
+ }>;
16
+ }, "strip", import("zod").ZodTypeAny, {
17
+ id: string;
18
+ width: number;
19
+ height: number;
20
+ urls: {
21
+ small: string;
22
+ full: string;
23
+ };
24
+ }, {
25
+ id: string;
26
+ width: number;
27
+ height: number;
28
+ urls: {
29
+ small: string;
30
+ full: string;
31
+ };
32
+ }>;
33
+ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod").ZodObject<{
34
+ results: import("zod").ZodArray<import("zod").ZodObject<{
35
+ id: import("zod").ZodString;
36
+ width: import("zod").ZodNumber;
37
+ height: import("zod").ZodNumber;
38
+ urls: import("zod").ZodObject<{
39
+ full: import("zod").ZodString;
40
+ small: import("zod").ZodString;
41
+ }, "strip", import("zod").ZodTypeAny, {
42
+ small: string;
43
+ full: string;
44
+ }, {
45
+ small: string;
46
+ full: string;
47
+ }>;
48
+ }, "strip", import("zod").ZodTypeAny, {
49
+ id: string;
50
+ width: number;
51
+ height: number;
52
+ urls: {
53
+ small: string;
54
+ full: string;
55
+ };
56
+ }, {
57
+ id: string;
58
+ width: number;
59
+ height: number;
60
+ urls: {
61
+ small: string;
62
+ full: string;
63
+ };
64
+ }>, "many">;
65
+ }, "strip", import("zod").ZodTypeAny, {
66
+ results: {
67
+ id: string;
68
+ width: number;
69
+ height: number;
70
+ urls: {
71
+ small: string;
72
+ full: string;
73
+ };
74
+ }[];
75
+ }, {
76
+ results: {
77
+ id: string;
78
+ width: number;
79
+ height: number;
80
+ urls: {
81
+ small: string;
82
+ full: string;
83
+ };
84
+ }[];
85
+ }>, {
86
+ id: string;
87
+ width: number;
88
+ height: number;
89
+ urls: {
90
+ small: string;
91
+ full: string;
92
+ };
93
+ }[], {
94
+ results: {
95
+ id: string;
96
+ width: number;
97
+ height: number;
98
+ urls: {
99
+ small: string;
100
+ full: string;
101
+ };
102
+ }[];
103
+ }>;
104
+ export declare type UnplashSearchApi = TypeOf<typeof unsplashSearchApiType>;
105
+ export declare type UnsplashImage = TypeOf<typeof unsplashImage>;
106
+ export declare function useUnsplashSearch(baseUrl: string, term: string): {
107
+ id: string;
108
+ width: number;
109
+ height: number;
110
+ urls: {
111
+ small: string;
112
+ full: string;
113
+ };
114
+ }[];
115
+ export {};
@@ -0,0 +1 @@
1
+ export { ImageField } from "./ImageField";
@@ -14,11 +14,11 @@ declare const _default: {
14
14
  start: number;
15
15
  end: number;
16
16
  type: "label" | "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
17
- })[];
17
+ })[] | undefined;
18
18
  };
19
19
  } & {
20
- label?: string;
21
- direction?: string;
20
+ label?: string | undefined;
21
+ direction?: string | undefined;
22
22
  }) => ProsemirrorNode | undefined;
23
23
  toPrismic(node: ProsemirrorNode, nodeType: "list-item" | "o-list-item"): readonly ({
24
24
  type: "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
@@ -31,11 +31,11 @@ declare const _default: {
31
31
  start: number;
32
32
  end: number;
33
33
  type: "label" | "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
34
- })[];
34
+ })[] | undefined;
35
35
  };
36
36
  } & {
37
- label?: string;
38
- direction?: string;
37
+ label?: string | undefined;
38
+ direction?: string | undefined;
39
39
  })[];
40
40
  };
41
41
  placeholder: string;
@@ -11,4 +11,4 @@ import { default as Paragraph } from "./Paragraph";
11
11
  export declare const DefaultExtension: import("../models").TextExtension;
12
12
  export declare const MarkExtensions: import("../models").MarkExtension<unknown>[];
13
13
  export declare const Extensions: (nodeTypes?: Set<RichTextNodeType>) => readonly WidgetExtension[];
14
- export { Bold, BulletList, CodeBlock, Embed, Heading, Italic, OrderedList, Paragraph, };
14
+ export { Bold, BulletList, CodeBlock, Embed, Heading, Italic, OrderedList, Paragraph };
@@ -14,8 +14,8 @@ export declare type MenuItem = Readonly<{
14
14
  text?: undefined;
15
15
  })>;
16
16
  declare type RunCommandsOptions = Readonly<{
17
- can?: boolean | undefined;
18
- deleteRange?: Range | undefined;
17
+ can?: boolean;
18
+ deleteRange?: Range;
19
19
  }>;
20
20
  export declare const ALL_NODE_ITEMS: readonly MenuItem[];
21
21
  export declare const ALL_MARK_ITEMS: readonly MenuItem[];