@prismicio/editor-fields 0.4.51 → 0.4.52-jp-onboarding-guide-triggers-highlight

package/dist/EditorConfig.d.ts

@@ -73,6 +73,12 @@ interface OnAnalyticsEvent {
         timeToAddMediaToPage: string;
         tags: string;
     }): void;
+    (event: "Generic Link Added", args: {
+        type: "web" | "media" | "document";
+        isInSlice: string;
+        isInGroup: string;
+        customTypeFormat: "page" | "custom";
+    }): void;
     (event: "Unsplash Image Searched" | "Unsplash Image Added"): void;
 }
 interface Analytics {

package/dist/FieldContext.d.ts

@@ -0,0 +1,27 @@
+import type { CustomType } from "@prismicio/types-internal/lib/customtypes";
+import { type PropsWithChildren, type ReactNode } from "react";
+type CustomTypeFormat = CustomType["format"];
+interface FieldContextValue {
+    customTypeFormat: CustomTypeFormat;
+    isInSlice: boolean;
+    isInGroup: boolean;
+}
+interface RootFieldContextProviderProps {
+    customTypeFormat: CustomTypeFormat;
+    children: ReactNode;
+}
+/**
+ * Provides extra context to the fields below.
+ * Use it only once at the root of the fields tree.
+ */
+export declare function RootFieldContextProvider(props: RootFieldContextProviderProps): JSX.Element;
+/**
+ * Overrides the field context to indicate that the field is in a slice.
+ */
+export declare function FieldInSliceContextProvider(props: PropsWithChildren): JSX.Element;
+/**
+ * Overrides the field context to indicate that the field is in a group.
+ */
+export declare function FieldInGroupContextProvider(props: PropsWithChildren): JSX.Element;
+export declare function useFieldContext(): FieldContextValue | undefined;
+export {};

package/dist/GroupEditor.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import type { GroupContent } from "@prismicio/types-internal/lib/content";
 import type { Group } from "@prismicio/types-internal/lib/customtypes";
-interface GroupEditorProps {
-    content: GroupContent | undefined;
+type GroupEditorProps = {
+content: GroupContent | undefined;
     group: Group;
     id: string;
     readOnly: boolean;

package/dist/SliceSelection.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-export interface SliceSelection {
-    /**
+export type SliceSelection = {
+/**
      * The keys of the slices that are currently selected.
      */
     ids: string[];
@@ -12,8 +12,8 @@ export interface SliceSelection {
      */
     update: (args: SliceSelectionUpdateArgs) => void;
 }
-export interface SliceSelectionUpdateArgs {
-    id: string;
+export type SliceSelectionUpdateArgs = {
+id: string;
     requestedFrom: "all" | SliceSelectionArea;
     shiftKey?: boolean;
     metaKey?: boolean;

package/dist/constants/framework.d.ts

@@ -4,3 +4,8 @@ export declare const frameworkLabels: {
     readonly sveltekit: "SvelteKit";
     readonly other: "Other";
 };
+export declare const frameworkCreateProjectCodeSnippet: {
+    readonly next: "npx create-next-app@latest";
+    readonly nuxt: "npx nuxi@latest init";
+    readonly sveltekit: "npx sv create";
+};

package/dist/core/MediaLibrary/components/MediaLibraryContext.d.ts

@@ -2,8 +2,8 @@ import { type MediaAssetType } from "@prismicio/editor-ui";
 import { type PropsWithChildren, type RefObject } from "react";
 import { type MediaAsset, type MediaLibraryFilters } from "../hooks/mediaLibraryData";
 import { type UploadFile } from "../hooks/useMediaLibraryUpload";
-interface MediaLibraryContextValue {
-    onScrollToBottom: () => void;
+type MediaLibraryContextValue = {
+onScrollToBottom: () => void;
     isFetchingMedia: boolean;
     media: MediaAsset[];
     mediaTotal: number;
@@ -42,8 +42,8 @@ interface MediaLibraryContextValue {
     setOpenMediaSection: (section: MediaSection | undefined) => void;
 }
 type MediaSection = "tags";
-interface MediaLibraryProviderProps extends PropsWithChildren {
-    /**
+type MediaLibraryProviderProps = PropsWithChildren & {
+/**
      * The type of media to allow in the media library.
      * @default all
      */

package/dist/core/MediaLibrary/components/MediaLibraryToast.d.ts

@@ -1,18 +1,18 @@
 import { type IconName } from "@prismicio/editor-ui";
 import { type ReactNode } from "react";
-interface MediaLibraryToastContextValue {
-    showToast: (config: ToastConfig) => void;
+type MediaLibraryToastContextValue = {
+showToast: (config: ToastConfig) => void;
 }
-interface MediaLibraryToastProviderProps {
-    children: ReactNode;
+type MediaLibraryToastProviderProps = {
+children: ReactNode;
 }
-interface ToastConfig {
-    title: string;
+type ToastConfig = {
+title: string;
     seconds?: number;
     action?: {
         title: string;
         onClick: () => void;
-    };
+};
     icon?: IconName;
 }
 export declare function MediaLibraryToastProvider(props: MediaLibraryToastProviderProps): JSX.Element;

package/dist/core/MediaLibrary/components/MediaList.d.ts

@@ -1,7 +1,7 @@
 import { type ReactNode, type RefObject } from "react";
 export declare function MediaList(): JSX.Element;
-interface MediaListScrollAreaProps {
-    children: ReactNode;
+type MediaListScrollAreaProps = {
+children: ReactNode;
     scrollAreaRef?: RefObject<HTMLDivElement>;
     onScrollToBottom?: () => void;
 }

package/dist/core/MediaLibrary/components/NewMediaLibraryFeaturesBanner.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-interface NewMediaLibraryFeaturesBannerProps {
-    maxWidth?: number;
+type NewMediaLibraryFeaturesBannerProps = {
+maxWidth?: number;
 }
 export declare function NewMediaLibraryFeaturesBanner(props: NewMediaLibraryFeaturesBannerProps): JSX.Element | null;
 export {};

package/dist/core/MediaLibrary/components/Sidepane/components/SidepaneContainer.d.ts

@@ -1,6 +1,6 @@
 import type { ReactNode } from "react";
-interface SidepaneContainerProps {
-    children: ReactNode;
+type SidepaneContainerProps = {
+children: ReactNode;
     hasSelectedMedia: boolean;
 }
 export declare function SidepaneContainer(props: SidepaneContainerProps): JSX.Element;

package/dist/core/MediaLibrary/components/Sidepane/components/SidepaneMetadataTags/SingleMediaMetadataTags.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { type MediaAsset } from "../../../../hooks/mediaLibraryData";
-interface SingleMediaMetadataTagsProps {
-    selectedMedia: MediaAsset;
+type SingleMediaMetadataTagsProps = {
+selectedMedia: MediaAsset;
 }
 export declare function SingleMediaMetadataTags(props: SingleMediaMetadataTagsProps): JSX.Element;
 export {};

package/dist/core/MediaLibrary/hooks/mediaLibraryData.d.ts

@@ -41,33 +41,33 @@ export declare const mediaAssetType: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }, {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
+    id: string;
+    kind: string;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    last_modified: number;
-    kind: string;
     filename: string;
+    last_modified: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
@@ -82,20 +82,20 @@ export declare const mediaAssetType: z.ZodObject<{
         credits?: string | undefined;
     } | undefined;
 }, {
+    id: string;
+    kind: string;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    last_modified: number;
-    kind: string;
     filename: string;
+    last_modified: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
@@ -156,33 +156,33 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }, {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
+        id: string;
+        kind: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        last_modified: number;
-        kind: string;
         filename: string;
+        last_modified: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -197,20 +197,20 @@ export declare const mediaSearchResponse: z.ZodObject<{
             credits?: string | undefined;
         } | undefined;
     }, {
+        id: string;
+        kind: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        last_modified: number;
-        kind: string;
         filename: string;
+        last_modified: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -226,22 +226,21 @@ export declare const mediaSearchResponse: z.ZodObject<{
         } | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    total: number;
     items: {
+        id: string;
+        kind: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        last_modified: number;
-        kind: string;
         filename: string;
+        last_modified: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -256,24 +255,24 @@ export declare const mediaSearchResponse: z.ZodObject<{
             credits?: string | undefined;
         } | undefined;
     }[];
+    total: number;
     cursor?: string | undefined;
 }, {
-    total: number;
     items: {
+        id: string;
+        kind: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        last_modified: number;
-        kind: string;
         filename: string;
+        last_modified: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -288,6 +287,7 @@ export declare const mediaSearchResponse: z.ZodObject<{
             credits?: string[] | undefined;
         } | undefined;
     }[];
+    total: number;
     cursor?: string | undefined;
 }>;
 export type MediaAsset = z.TypeOf<typeof mediaAssetType>;
@@ -306,22 +306,21 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     uploaderId: string | undefined;
     tags: string;
     page: number;
-    total: number;
     items: {
+        id: string;
+        kind: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        last_modified: number;
-        kind: string;
         filename: string;
+        last_modified: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -336,6 +335,7 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
             credits?: string | undefined;
         } | undefined;
     }[];
+    total: number;
     cursor?: string | undefined;
 }>;
 interface UseMediaLibrarySearchArgs {
@@ -357,20 +357,20 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
     media: {
+        id: string;
+        kind: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        last_modified: number;
-        kind: string;
         filename: string;
+        last_modified: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -407,20 +407,20 @@ declare function deleteMedia(mediaIds: string[]): void;
 declare function deleteSearchData(args: MediaLibraryFilters): void;
 type MediaPage = Awaited<ReturnType<typeof searchMedia>>;
 export declare function getMedia(allPages: MediaPage[], keyword: string, assetType: MediaAssetType, uploaderId: string | undefined, tags: string): {
+    id: string;
+    kind: string;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    last_modified: number;
-    kind: string;
     filename: string;
+    last_modified: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;

package/dist/core/MediaLibrary/hooks/tagData.d.ts

@@ -3,8 +3,8 @@ export declare function useTagSearch(): {
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
@@ -22,15 +22,15 @@ export declare const tagSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string;
     name: string;
-    created_at: number;
     last_modified: number;
+    created_at: number;
     count: number;
     uploader_id?: string | undefined;
 }, {
     id: string;
     name: string;
-    created_at: number;
     last_modified: number;
+    created_at: number;
     uploader_id?: string | undefined;
     count?: number | undefined;
 }>;

package/dist/core/MediaLibrary/hooks/uploadersData.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
-export interface UploaderWithMeta {
-    id: string;
+export type UploaderWithMeta = {
+id: string;
     name: string;
     firstName?: string;
     lastName?: string;

package/dist/core/MediaLibrary/hooks/useMediaLibraryAnalytics.d.ts

@@ -1,13 +1,13 @@
 import { type MediaAssetType } from "@prismicio/editor-ui";
-interface AnalyticsMediaSearchArgs {
-    assetType: MediaAssetType;
+type AnalyticsMediaSearchArgs = {
+assetType: MediaAssetType;
     keyword: string;
     tagIds: string[];
     mode: "select" | "browse";
 }
 export declare function useMediaLibraryAnalyticsMediaSearch(args: AnalyticsMediaSearchArgs): void;
-interface AnalyticsMediaAddedToPageArgs {
-    assetType: MediaAssetType;
+type AnalyticsMediaAddedToPageArgs = {
+assetType: MediaAssetType;
     mediaDialogOpen: boolean;
 }
 export declare function useMediaLibraryAnalyticsMediaAddedToPage(args: AnalyticsMediaAddedToPageArgs): (mediaId: string) => void;

package/dist/core/MediaLibrary/hooks/useMediaLibraryCacheInvalidation.d.ts

@@ -1,8 +1,8 @@
 import { type MediaAssetType } from "@prismicio/editor-ui";
 import type { EditorConfig } from "../../../EditorConfig";
 import { type SearchMediaArgs } from "./mediaLibraryData";
-interface UseMediaLibraryCacheInvalidationArgs {
-    revalidate: () => void;
+type UseMediaLibraryCacheInvalidationArgs = {
+revalidate: () => void;
     config: EditorConfig;
     keyword: string;
     assetType: MediaAssetType;

package/dist/core/MediaLibrary/hooks/useMediaLibraryUpload.d.ts

@@ -1,18 +1,18 @@
 import { type MediaAsset } from "../hooks/mediaLibraryData";
 export type UploadFile = NewUploadFile | UploadedFile;
-interface NewUploadFile {
-    id: string;
+type NewUploadFile = {
+id: string;
     file: File;
     status: "idle" | "uploading" | "error";
 }
-interface UploadedFile {
-    id: string;
+type UploadedFile = {
+id: string;
     file: File;
     status: "success";
     response: MediaAsset;
 }
-interface UseMediaLibraryUploadArgs {
-    /**
+type UseMediaLibraryUploadArgs = {
+/**
      * The upload is about to begin.
      */
     onBeforeUpload: (files: UploadFile[]) => void;

package/dist/core/MediaLibrary/hooks/useSelectedMedia.d.ts

@@ -1,18 +1,18 @@
 export declare function useSelectedMedia(): {
+    id: string;
+    kind: string;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    last_modified: number;
-    kind: string;
     filename: string;
+    last_modified: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;

package/dist/core/OnboardingGuide/OnboardingGuide.d.ts

@@ -1,11 +1,14 @@
 import { type ReactNode } from "react";
-import type { OnboardingState, OnboardingTracking } from "../service";
-interface OnboardingGuideProps {
+import type { OnboardingState, OnboardingStepId, OnboardingTracking } from "../service";
+export interface OnboardingGuideProps {
     onboardingState: OnboardingState;
     tracking: OnboardingTracking;
-    onToggleStep: (stepId: string) => Promise<string[]>;
+    onToggleStep: (stepId: OnboardingStepId) => Promise<string[]>;
     onToggleGuide: () => Promise<void>;
     fallback?: ReactNode;
+    /** This allows consumers of the onboarding to do something else for certain steps other than opening the modal. */
+    stepOverrides?: Partial<Record<OnboardingStepId, () => void>>;
+    repositoryName?: string;
+    projectName?: string;
 }
 export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element | null;
-export {};

package/dist/core/OnboardingGuide/components/OnboardingCard.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import type { OnboardingStep, OnboardingTracking } from "../../service";
+import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
 interface OnboardingCardProps {
     steps: OnboardingStep[];
     completedSteps: string[];
@@ -7,6 +7,7 @@ interface OnboardingCardProps {
     tracking: OnboardingTracking;
     onToggleStep: (step: OnboardingStep) => Promise<void>;
     onClose?: () => void;
+    stepOverrides?: Partial<Record<OnboardingStepId, () => void>>;
 }
 export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;
 export {};

package/dist/core/OnboardingGuide/components/OnboardingProgressStepper.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="react" />
-import type { OnboardingStep, OnboardingTracking } from "../../service";
+import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
 interface OnboardingProgressStepperProps {
     steps: OnboardingStep[];
     completedSteps: string[];
     onToggleStep: (step: OnboardingStep) => Promise<void>;
     tracking: OnboardingTracking;
+    stepOverrides?: Partial<Record<OnboardingStepId, () => void>>;
 }
 export declare function OnboardingProgressStepper(props: OnboardingProgressStepperProps): JSX.Element | null;
 export {};

package/dist/core/OnboardingGuide/components/OnboardingStepDialog.d.ts

@@ -1,12 +1,13 @@
-/// <reference types="react" />
+import { type RefObject } from "react";
 import type { OnboardingStep } from "../../service";
 interface OnboardingStepDialogProps {
     isOpen: boolean;
     step: OnboardingStep;
     stepIndex: number;
     isStepComplete: boolean;
-    onActionClick: () => Promise<void>;
+    onActionClick: (isUndo?: boolean) => Promise<void>;
     onClose: () => void;
+    contentRef: RefObject<HTMLDivElement>;
 }
 export declare function OnboardingStepDialog(props: OnboardingStepDialogProps): JSX.Element;
 export {};

package/dist/core/OnboardingGuide/content.d.ts

@@ -1,6 +1,13 @@
 import type { OnboardingFramework, OnboardingStep } from "../service/onboarding";
-export declare function getOnboardingContent(framework?: OnboardingFramework, starter?: string | null): {
+type Context = {
+    framework?: OnboardingFramework;
+    starter?: string | null;
+    repositoryName?: string;
+    projectName?: string;
+};
+export declare function getOnboardingContent(context: Context): {
     steps: OnboardingStep[];
-    defaultCompletedStepIds: string[];
+    defaultCompletedStepIds: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
     tutorialLink: string | undefined;
 };
+export {};