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

package/dist/EditorConfig.d.ts

@@ -47,14 +47,14 @@ type IntegrationFields = {
     integrationFieldsApiBaseUrl: URL;
     repository: string;
 };
-type LayoutConfig = {
-/**
+interface LayoutConfig {
+    /**
      * Teaches fields about their containing scrolling element.
      */
     scrollOffsetTop?: number;
 }
-type OnAnalyticsEvent = {
-(event: "Media Library Search", args: {
+interface OnAnalyticsEvent {
+    (event: "Media Library Search", args: {
         assetType: MediaAssetType;
         mode: "browse" | "select";
         searchQuery: string;
@@ -62,7 +62,7 @@ type OnAnalyticsEvent = {
         numberOfResults: string;
         timeToGetResults: string;
         tags: string;
-}): void;
+    }): void;
     (event: "Media Added To Page", args: {
         assetType: MediaAssetType;
         searchQuery: string;
@@ -73,13 +73,19 @@ type 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;
 }
-type Analytics = {
-onAnalyticsEvent?: OnAnalyticsEvent;
+interface Analytics {
+    onAnalyticsEvent?: OnAnalyticsEvent;
 }
-type ErrorTracking = {
-/** Asks the editor to track this Error in its Error monitoring solution. */
+interface ErrorTracking {
+    /** Asks the editor to track this Error in its Error monitoring solution. */
     onTrackError?: (error: Error) => void;
 }
 export type AuthStrategy = "cookie" | "token";

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/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/hooks/mediaLibraryData.d.ts

@@ -54,6 +54,9 @@ export declare const mediaAssetType: z.ZodObject<{
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
+    id: string;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
@@ -62,11 +65,8 @@ export declare const mediaAssetType: z.ZodObject<{
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    kind: string;
     last_modified: number;
+    kind: string;
     filename: string;
     extension?: string | undefined;
     width?: number | undefined;
@@ -82,6 +82,9 @@ export declare const mediaAssetType: z.ZodObject<{
         credits?: string | undefined;
     } | undefined;
 }, {
+    id: string;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
@@ -90,11 +93,8 @@ export declare const mediaAssetType: z.ZodObject<{
         uploader_id?: string | undefined;
         count?: number | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    kind: string;
     last_modified: number;
+    kind: string;
     filename: string;
     extension?: string | undefined;
     width?: number | undefined;
@@ -169,6 +169,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
+        id: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
@@ -177,11 +180,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        kind: string;
         last_modified: number;
+        kind: string;
         filename: string;
         extension?: string | undefined;
         width?: number | undefined;
@@ -197,6 +197,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
             credits?: string | undefined;
         } | undefined;
     }, {
+        id: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
@@ -205,11 +208,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        kind: string;
         last_modified: number;
+        kind: string;
         filename: string;
         extension?: string | undefined;
         width?: number | undefined;
@@ -228,6 +228,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
+        id: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
@@ -236,11 +239,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        kind: string;
         last_modified: number;
+        kind: string;
         filename: string;
         extension?: string | undefined;
         width?: number | undefined;
@@ -260,6 +260,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, {
     total: number;
     items: {
+        id: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
@@ -268,11 +271,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        kind: string;
         last_modified: number;
+        kind: string;
         filename: string;
         extension?: string | undefined;
         width?: number | undefined;
@@ -308,6 +308,9 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     page: number;
     total: number;
     items: {
+        id: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
@@ -316,11 +319,8 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        kind: string;
         last_modified: number;
+        kind: string;
         filename: string;
         extension?: string | undefined;
         width?: number | undefined;
@@ -357,6 +357,9 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
     media: {
+        id: string;
+        url: string;
+        size: number;
         tags: {
             id: string;
             name: string;
@@ -365,11 +368,8 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        size: number;
-        kind: string;
         last_modified: number;
+        kind: string;
         filename: string;
         extension?: string | undefined;
         width?: number | undefined;
@@ -407,6 +407,9 @@ 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;
+    url: string;
+    size: number;
     tags: {
         id: string;
         name: string;
@@ -415,11 +418,8 @@ export declare function getMedia(allPages: MediaPage[], keyword: string, assetTy
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    size: number;
-    kind: string;
     last_modified: number;
+    kind: string;
     filename: string;
     extension?: string | undefined;
     width?: number | undefined;

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

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

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

@@ -1,13 +1,14 @@
 import { type ReactNode } from "react";
 import type { OnboardingState, OnboardingStepId, OnboardingTracking } from "../service";
-interface OnboardingGuideProps {
+export interface OnboardingGuideProps {
     onboardingState: OnboardingState;
     tracking: OnboardingTracking;
     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. */
-    stepContentOverride?: Partial<Record<OnboardingStepId, ReactNode>>;
+    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,4 +1,4 @@
-import type { ReactNode } from "react";
+/// <reference types="react" />
 import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
 interface OnboardingCardProps {
     steps: OnboardingStep[];
@@ -7,7 +7,7 @@ interface OnboardingCardProps {
     tracking: OnboardingTracking;
     onToggleStep: (step: OnboardingStep) => Promise<void>;
     onClose?: () => void;
-    stepContentOverride?: Partial<Record<OnboardingStepId, ReactNode>>;
+    stepOverrides?: Partial<Record<OnboardingStepId, () => void>>;
 }
 export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;
 export {};

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

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

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

@@ -1,13 +1,13 @@
-import { type ReactNode } from "react";
-import type { OnboardingStep, OnboardingStepId } from "../../service";
+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;
-    stepContentOverride?: Partial<Record<OnboardingStepId, ReactNode>>;
+    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: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
     tutorialLink: string | undefined;
 };
+export {};

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

@@ -1 +1 @@
-export { OnboardingGuide } from "./OnboardingGuide";
+export { OnboardingGuide, type OnboardingGuideProps } from "./OnboardingGuide";

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

@@ -6,20 +6,20 @@ declare const customTypeResponse: z.ZodObject<{
     repeatable: z.ZodBoolean;
     status: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
-    label: string;
     id: string;
+    label: string;
     status: boolean;
     repeatable: boolean;
 }, {
-    label: string;
     id: string;
+    label: string;
     status: boolean;
     repeatable: boolean;
 }>;
 export type CustomTypeResponse = z.TypeOf<typeof customTypeResponse>;
 export declare function getRepositoryCustomTypes(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<{
-    label: string;
     id: string;
+    label: string;
     status: boolean;
     repeatable: boolean;
 }[]>;