@prismicio/editor-fields 0.4.50 → 0.4.52-jp-onboarding-guide-triggers.1

package/dist/core/service/onboarding.d.ts

@@ -2,18 +2,20 @@
 import { z } from "zod";
 import { type AuthStrategy } from "../../EditorConfig";
 export interface OnboardingStep {
-    id: string;
+    id: OnboardingStepId;
     title: string;
     description: string;
     content?: JSX.Element;
     videoUrl?: string;
     defaultCompleted?: boolean;
 }
+export declare const OnboardingStepId: z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>;
+export type OnboardingStepId = z.infer<typeof OnboardingStepId>;
 export declare const onboardingStateSchema: z.ZodObject<{
     completedSteps: z.ZodArray<z.ZodString, "many">;
     isDismissed: z.ZodBoolean;
     context: z.ZodObject<{
-        framework: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>>>;
+        framework: z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>;
         starterId: z.ZodNullable<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         framework: "next" | "nuxt" | "sveltekit" | "other";

package/dist/fields/ImageField/Components/ImageAltControl.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-interface ImageAltControlProps {
-    readOnly?: boolean;
+type ImageAltControlProps = {
+readOnly?: boolean;
     altText: string;
     selected?: boolean;
     onValueChange: (value: string) => void;

package/dist/fields/ImageField/Components/ImageFieldTitle.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-interface ImageFieldTitleProps {
-    fieldLabel: string;
+type ImageFieldTitleProps = {
+fieldLabel: string;
     imageLabel?: string[];
 }
 export declare function ImageFieldTitle(props: ImageFieldTitleProps): JSX.Element;

package/dist/fields/ImageField/CropperDialog/CropperDialog.d.ts

@@ -1,8 +1,8 @@
 import { type ReactNode } from "react";
 import type { CropperImage } from "../../../core/imageUtils";
 import { type CroppedImage } from "./croppedImage";
-interface CropperDialogProps {
-    trigger: React.ReactNode;
+type CropperDialogProps = {
+trigger: React.ReactNode;
     /** Flattened list of all thumbnails in the field */
     initialImages: CropperImage[];
     /** Index of the initial image displayed in the cropper */
@@ -10,7 +10,7 @@ interface CropperDialogProps {
     onClose: (result: {
         croppedImages: CroppedImages;
         option: number;
-    }) => void;
+}) => void;
     renderTooltip: (trigger: ReactNode) => ReactNode;
 }
 export declare function CropperDialog(props: CropperDialogProps): JSX.Element;

package/dist/fields/ImageField/CropperDialog/croppedImage.d.ts

@@ -1,22 +1,22 @@
 import { type ImageContent, type ImageContentView } from "@prismicio/types-internal/lib/content";
 import type { Image } from "@prismicio/types-internal/lib/customtypes";
 import { type ImageBlockData } from "../../../core/imageUtils";
-export interface Point {
-    x: number;
+export type Point = {
+x: number;
     y: number;
 }
-export interface Size {
-    width: number;
+export type Size = {
+width: number;
     height: number;
 }
-export interface CropArea {
-    x: number;
+export type CropArea = {
+x: number;
     y: number;
     width: number;
     height: number;
 }
-export interface CroppedImage {
-    zoom: number;
+export type CroppedImage = {
+zoom: number;
     /** x coordinate of the crop rect on the original image */
     x: number;
     /** y coordinate of the crop rect on the original image */
@@ -42,8 +42,8 @@ interface UpdateImageMainThumbnailArgs<T> {
     croppedImage: CroppedImage;
 }
 export declare function updateImageMainThumbnail<T extends ImageContent | ImageBlockData>(args: UpdateImageMainThumbnailArgs<T>): T;
-interface BuildCropUrlArgs {
-    origin: ImageContent["origin"];
+type BuildCropUrlArgs = {
+origin: ImageContent["origin"];
     /** Image crop parameters */
     croppedImage: CroppedImage;
 }

package/dist/fields/ImageField/MediaDialog/MediaDialog.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { type MediaAssetType } from "@prismicio/editor-ui";
 import { type MediaAssetOrExternalImage } from "../../../core/MediaLibrary/hooks/mediaLibraryData";
-interface MediaDialogProps {
-    assetType: MediaAssetType;
+type MediaDialogProps = {
+assetType: MediaAssetType;
     open: boolean;
     onOpenChange: (open: boolean) => void;
     onMediaSelected: (media: MediaAssetOrExternalImage) => void;

package/dist/fields/ImageField/useImageField.d.ts

@@ -2,8 +2,8 @@ import type { ImageContent } from "@prismicio/types-internal/lib/content";
 import type { Image } from "@prismicio/types-internal/lib/customtypes";
 import type { MediaAssetOrExternalImage } from "../../core/MediaLibrary/hooks/mediaLibraryData";
 import type { CroppedImages } from "./CropperDialog";
-interface useImageFieldProps {
-    content: ImageContent | undefined;
+type useImageFieldProps = {
+content: ImageContent | undefined;
     field: Image;
     onContentChange: (content: ImageContent | undefined) => void;
 }

package/dist/fields/IntegrationField/IntegrationInput.d.ts

@@ -1,21 +1,21 @@
 /// <reference types="react" />
 import { IntegrationField as IntegrationFieldT } from "@prismicio/types-internal/lib/customtypes";
 import { type IntegrationItem } from "./integrationData";
-interface IntegrationSharedInputProps {
-    id: string;
+type IntegrationSharedInputProps = {
+id: string;
     field: IntegrationFieldT;
     readOnly: boolean;
     onFocus: () => void;
     onClearItem: () => void;
 }
-interface IntegrationInputProps extends IntegrationSharedInputProps {
-    catalogId: string;
+type IntegrationInputProps = IntegrationSharedInputProps & {
+catalogId: string;
     itemId?: string;
     item?: IntegrationItem;
 }
 export declare function IntegrationInput(props: IntegrationInputProps): JSX.Element;
-interface IntegrationFooterProps {
-    catalogId: string;
+type IntegrationFooterProps = {
+catalogId: string;
     itemId?: string;
     item?: IntegrationItem;
 }

package/dist/fields/IntegrationField/integrationData.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
-interface IntegrationCatalogSearchArgs {
-    searchTerm: string;
+type IntegrationCatalogSearchArgs = {
+searchTerm: string;
     catalogId: string;
 }
 export declare function useIntegrationCatalogSearch(args: IntegrationCatalogSearchArgs): {
@@ -40,8 +40,8 @@ declare const integrationItem: z.ZodObject<{
     description?: string | undefined;
 }>;
 export type IntegrationItem = z.TypeOf<typeof integrationItem>;
-interface IntegrationCatalogReadArgs {
-    catalogId: string;
+type IntegrationCatalogReadArgs = {
+catalogId: string;
     itemId: string;
 }
 export declare function useIntegrationCatalogRead(args: IntegrationCatalogReadArgs): {

package/dist/fields/LinkField/Documents/DocumentsModal.d.ts

@@ -1,15 +1,15 @@
 /// <reference types="react" />
 import { type FilterOption } from "@prismicio/editor-ui";
-interface DocumentsModalProps {
-    open: boolean;
+type DocumentsModalProps = {
+open: boolean;
     onOpenChange: (open: boolean) => void;
     onSelectDocument: (documentID: string) => void;
     fixedCustomTypes?: Set<string>;
     fixedTags?: Set<string>;
 }
 export declare function DocumentsModal(props: DocumentsModalProps): JSX.Element;
-interface SortTagsByFilteredTagsArgs {
-    tagsFilter: Set<FilterOption>;
+type SortTagsByFilteredTagsArgs = {
+tagsFilter: Set<FilterOption>;
     tags: string[];
 }
 export declare function sortTagsByFilteredTags(args: SortTagsByFilteredTagsArgs): string[];

package/dist/fields/LinkField/Documents/Filters.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { type FilterOption } from "@prismicio/editor-ui";
-interface DocumentsListFiltersProps {
-    filteredLocales: Set<FilterOption>;
+type DocumentsListFiltersProps = {
+filteredLocales: Set<FilterOption>;
     setFilteredLocales: (newValue: Set<FilterOption>) => void;
     filteredTags: Set<FilterOption>;
     setFilteredTags: (newValue: Set<FilterOption>) => void;
@@ -11,8 +11,8 @@ interface DocumentsListFiltersProps {
     fixedTags?: Set<string>;
 }
 export declare function DocumentsListFilters(props: DocumentsListFiltersProps): JSX.Element;
-interface FilterProps {
-    onSelectedValuesChange: (selectedValues: Set<FilterOption>) => void;
+type FilterProps = {
+onSelectedValuesChange: (selectedValues: Set<FilterOption>) => void;
     fixedSelectedValues?: Set<FilterOption>;
     selectedValues: Set<FilterOption>;
     label: string;
@@ -21,8 +21,8 @@ interface FilterProps {
     multiple?: boolean;
 }
 export declare function Filter(props: FilterProps): JSX.Element;
-interface LocalesFilterProps {
-    selectedValues: Set<FilterOption>;
+type LocalesFilterProps = {
+selectedValues: Set<FilterOption>;
     onSelectedValuesChange: (selectedValues: Set<FilterOption>) => void;
 }
 export declare function LocalesFilter(props: LocalesFilterProps): JSX.Element;

package/dist/fields/LinkField/LinkDescriptionCard.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { type IconName } from "@prismicio/editor-ui";
-export interface LinkDescriptionCardProps {
-    url?: URL | string;
+export type LinkDescriptionCardProps = {
+url?: URL | string;
     title?: string;
     subTitle?: string;
     description?: string;

package/dist/fields/LinkField/LinkField.d.ts

@@ -2,26 +2,26 @@
 import { FilledLinkContent, type LinkContent } from "@prismicio/types-internal/lib/content";
 import type { Link } from "@prismicio/types-internal/lib/customtypes";
 import { type FieldSelectType } from "./LinkFieldActions";
-interface LinkFieldProps {
-    id?: string;
+type LinkFieldProps = {
+id?: string;
     field: Link;
     content: LinkContent | undefined;
     condensedButtons?: boolean;
     onContentChange: (content: LinkContent | undefined) => void;
 }
 export declare function LinkField(props: LinkFieldProps): JSX.Element;
-interface GetFieldIconArgs {
-    selectType?: FieldSelectType;
+type GetFieldIconArgs = {
+selectType?: FieldSelectType;
     displayTextEnabled?: boolean;
 }
 export declare function getFieldIcon(args: GetFieldIconArgs): "image" | "description" | "link" | "notes" | "public";
-interface FilledLinkFieldProps {
-    id?: string;
+type FilledLinkFieldProps = {
+id?: string;
     condensedButtons?: boolean;
     field: Link & {
         config?: {
             allowText?: false;
-        };
+};
     };
     content: FilledLinkContent | undefined;
     onContentChange: (content: FilledLinkContent | undefined) => void;

package/dist/fields/LinkField/LinkImageCard.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-export interface LinkImageCardProps {
-    url: string;
+export type LinkImageCardProps = {
+url: string;
     title: string;
     subTitle: string;
     onEdit?: () => void;

package/dist/fields/LinkField/useLinkField.d.ts

@@ -10,8 +10,8 @@ interface useLinkFieldParams {
     onContentChange: (content: LinkContent | undefined) => void;
 }
 export declare function useLinkField(params: useLinkFieldParams): {
-    contentType: "DocumentLink" | "ImageLink" | "FileLink" | "ExternalLink" | "MediaLink" | "AnyLink" | undefined;
-    selectType: "document" | "media" | "web" | "any" | undefined;
+    contentType: "ImageLink" | "FileLink" | "DocumentLink" | "ExternalLink" | "MediaLink" | "AnyLink" | undefined;
+    selectType: "document" | "web" | "media" | "any" | undefined;
     fieldValue: string;
     onDisplayTextChange: (displayText: string) => void;
     onValueChange: (value: string, newTab?: boolean) => void;

package/dist/fields/RichTextField/BubbleMenu/Label/LabelItems.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
-interface NodeItemsProps {
-    labels: string[];
+type NodeItemsProps = {
+labels: string[];
     editor: Editor;
 }
 export declare function LabelItems(props: NodeItemsProps): JSX.Element;

package/dist/fields/RichTextField/BubbleMenu/Link/DocumentDescriptionCard.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-interface DocumentDescriptionCardProps {
-    docId: string;
+type DocumentDescriptionCardProps = {
+docId: string;
     onEdit: () => void;
     onUnlink: () => void;
 }

package/dist/fields/RichTextField/BubbleMenu/Link/LinkItems.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
 import type { Modal } from "../BubbleMenu";
-interface LinkItemsProps {
-    editor: Editor;
+type LinkItemsProps = {
+editor: Editor;
     setModal: (modal: Modal) => void;
 }
 export declare function LinkItems(props: LinkItemsProps): JSX.Element;

package/dist/fields/RichTextField/BubbleMenu/Link/LinkPopover.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
-interface LinkPopoverProps {
-    editor: Editor;
+type LinkPopoverProps = {
+editor: Editor;
     onEditWebLink: () => void;
     onEditDocumentLink: () => void;
     onEditMediaLink: () => void;
 }
 export declare function LinkPopover(props: LinkPopoverProps): JSX.Element | null;
-interface DocumentLinkPopoverProps {
-    editor: Editor;
+type DocumentLinkPopoverProps = {
+editor: Editor;
     onEditDocumentLink: () => void;
     docId: string;
 }

package/dist/fields/RichTextField/BubbleMenu/Link/SetMediaLinkModal.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
-interface SetMediaLinkModalProps {
-    open: boolean;
+type SetMediaLinkModalProps = {
+open: boolean;
     setOpen: (open: boolean) => void;
     editor: Editor;
 }

package/dist/fields/RichTextField/BubbleMenu/Link/SetWebLinkModal.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
-interface SetWebLinkModalProps {
-    open: boolean;
+type SetWebLinkModalProps = {
+open: boolean;
     editor: Editor;
     setOpen: (open: boolean) => void;
 }

package/dist/fields/RichTextField/BubbleMenu/MarkItems.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
 import type { MenuItem } from "../models/MenuItems";
-interface MarkItemsProps {
-    items: MenuItem[];
+type MarkItemsProps = {
+items: MenuItem[];
     editor: Editor;
 }
 export declare function MarkItems(props: MarkItemsProps): JSX.Element | null;

package/dist/fields/RichTextField/BubbleMenu/NodeItems.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import type { Editor } from "@tiptap/core";
 import type { MenuItem } from "../models/MenuItems";
-interface NodeItemsProps {
-    items: MenuItem[];
+type NodeItemsProps = {
+items: MenuItem[];
     editor: Editor;
 }
 export declare function NodeItems(props: NodeItemsProps): JSX.Element | null;

package/dist/fields/RichTextField/coreExtensions/ListItem.d.ts

@@ -3,7 +3,7 @@ declare const _default: {
     component: import("@tiptap/core").Node<import("@tiptap/extension-list-item").ListItemOptions, any>;
     converter: {
         fromPrismic(schema: Schema<any, any>): (list: {
-            type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
+            type: "image" | "em" | "embed" | "strong" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "list-item" | "o-list-item" | "rtl";
             content: {
                 text: string;
             } & {
@@ -64,7 +64,7 @@ declare const _default: {
             direction?: string | undefined;
         }) => ProsemirrorNode | undefined;
         toPrismic(node: ProsemirrorNode, nodeType: "list-item" | "o-list-item"): readonly ({
-            type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
+            type: "image" | "em" | "embed" | "strong" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "list-item" | "o-list-item" | "rtl";
             content: {
                 text: string;
             } & {

package/dist/fields/RichTextField/extensions/Label/Label.d.ts

@@ -1,10 +1,10 @@
 import { LabelExtension } from "./LabelModel";
-export interface LabelProtocolOptions {
-    scheme: string;
+export type LabelProtocolOptions = {
+scheme: string;
     optionalSlashes?: boolean;
 }
-export interface LabelOptions {
-    /** These are the values passed into the HTML through the Tiptap extension. */
+export type LabelOptions = {
+/** These are the values passed into the HTML through the Tiptap extension. */
     htmlAttributes: Record<string, any>;
 }
 declare module "@tiptap/core" {

package/dist/fields/RichTextField/extensions/Label/LabelModel.d.ts

@@ -16,8 +16,8 @@ export declare class LabelExtension {
         toPrismic(elmt: ProsemirrorMark): LabelElementData;
     });
 }
-export interface LabelElement {
-    type: "label";
+export type LabelElement = {
+type: "label";
     start: number;
     end: number;
     data: LabelElementData;

package/dist/fields/RichTextField/extensions/Link/LinkModel.d.ts

@@ -16,15 +16,15 @@ export declare class LinkExtension {
         toPrismic(elmt: ProsemirrorMark): LinkElementData;
     });
 }
-export interface LinkElement {
-    type: "hyperlink";
+export type LinkElement = {
+type: "hyperlink";
     start: number;
     end: number;
     data: LinkElementData;
 }
 export type LinkElementData = ImageLinkData | FileLinkData | DocumentLinkData | ExternalLinkData;
-export interface ImageLinkData {
-    __TYPE__: "ImageLink";
+export type ImageLinkData = {
+__TYPE__: "ImageLink";
     id: string;
     url: string;
     height: string;
@@ -34,8 +34,8 @@ export interface ImageLinkData {
     kind: string;
     date?: string | null | undefined;
 }
-export interface FileLinkData {
-    __TYPE__: "FileLink";
+export type FileLinkData = {
+__TYPE__: "FileLink";
     id: string;
     url: string;
     name: string;
@@ -43,17 +43,17 @@ export interface FileLinkData {
     size: string;
     date?: string | null | undefined;
 }
-interface DocumentLinkData {
-    __TYPE__: "DocumentLink";
+type DocumentLinkData = {
+__TYPE__: "DocumentLink";
     id: string;
 }
-interface ExternalLinkData {
-    __TYPE__: "ExternalLink";
+type ExternalLinkData = {
+__TYPE__: "ExternalLink";
     url: string;
     kind?: "web";
     target?: string | null | undefined;
     preview?: {
         title?: string;
-    } | null | undefined;
+} | null | undefined;
 }
 export {};

package/dist/fields/RichTextField/globalExtensions/TextDirection.d.ts

@@ -4,8 +4,8 @@ import type { Node as ProsemirrorNode } from "prosemirror-model";
 export type Direction = "ltr" | "rtl";
 export declare const leftToRight: Direction;
 export declare const rightToLeft: Direction;
-interface TextDirectionOptions {
-    supportedExtensionNames: string[];
+type TextDirectionOptions = {
+supportedExtensionNames: string[];
 }
 export declare const attrName = "dir";
 declare module "@tiptap/core" {

package/dist/fields/RichTextField/models/RichTextConfig.d.ts

@@ -1,8 +1,8 @@
 import { RichTextConfig, type RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
 import { type WidgetExtension } from "./EditorExtension";
 export declare function composeExtensions(config?: RichTextConfig): Extensions;
-interface Extensions {
-    extensions: WidgetExtension[];
+type Extensions = {
+extensions: WidgetExtension[];
     nodeTypes: Set<RichTextNodeType>;
 }
 export {};