@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.0 → 0.4.49-alpha.feat-onboarding-guide.2

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

@@ -9,7 +9,7 @@ export declare function useTagSearch(): {
         uploader_id?: string | undefined;
     }[];
 };
-export declare const minTagNameLength = 3;
+export declare const minTagNameLength = 1;
 export declare const maxTagNameLength = 20;
 export declare const tagNameSchema: z.ZodString;
 export declare const tagSchema: z.ZodObject<{

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

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant, OnboardingTrackingFn } from "./types";
+import type { OnboardingCardVariant, OnboardingFramework, OnboardingState, OnboardingStepId, OnboardingTrackFn } from "./types";
 interface OnboardingGuideProps {
     /**
      * Whether the whole guide (including 'Get started' button) should be visible
@@ -13,10 +13,41 @@ interface OnboardingGuideProps {
      * @default "default"
      */
     variant?: OnboardingCardVariant;
-    /** Link to the video tutorials */
-    tutorialLink?: string;
-    /** Function to track onboarding events */
-    trackingFn: OnboardingTrackingFn;
+    /**
+     * The framework the user is using
+     *
+     * Used to display a link to the appropriate tutorial
+     * @default "other"
+     */
+    framework?: OnboardingFramework;
+    /**
+     * Function to track onboarding events
+     *
+     *  - onboarding:step-completed,
+     *  - onboarding:step-opened,
+     *  - onboarding:guide-completed
+     * */
+    track: OnboardingTrackFn;
+    /**
+     * Fetches the current onboarding state
+     *
+     * @returns {OnboardingState}
+     */
+    fetchState: () => Promise<OnboardingState>;
+    /**
+     * Updates the onboarding steps progress state
+     *
+     * @param {OnboardingStepId[]} stepId
+     */
+    toggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
+    /**
+     * Updates the onboarding guide state to completed
+     *
+     * @returns {boolean}
+     */
+    resolveGuide: () => Promise<{
+        isResolved: boolean;
+    }>;
 }
 export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element;
 export {};

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

@@ -1,8 +1,5 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant } from "../types";
 interface OnboardingCardProps {
-    variant: OnboardingCardVariant;
-    tutorialLink?: string;
     onClose?: () => void;
 }
 export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;

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

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+interface OnboardingGuideUIProps {
+    isOnboardingVisible: boolean;
+    isFadedOut: boolean;
+    resolveGuide: () => Promise<{
+        isResolved: boolean;
+    }>;
+}
+export declare function OnboardingGuideUI(props: OnboardingGuideUIProps): JSX.Element;
+export {};

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

@@ -1,20 +1,26 @@
 import { type ReactNode } from "react";
-import { type OnboardingCardVariant, type OnboardingStep, type OnboardingStepId, type OnboardingTrackingFn } from "../types";
+import { type OnboardingCardVariant, type OnboardingFramework, type OnboardingState, type OnboardingStep, type OnboardingStepId, type OnboardingTrackFn } from "../types";
+interface OnboardingProviderProps {
+    children: ReactNode;
+    variant: OnboardingCardVariant;
+    framework: OnboardingFramework;
+    onComplete?: () => void;
+    track: OnboardingTrackFn;
+    fetchState: () => Promise<OnboardingState>;
+    toggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
+}
+export declare function OnboardingProvider(props: OnboardingProviderProps): JSX.Element;
 interface OnboardingContext {
     steps: OnboardingStep[];
-    completedStepCount: number;
+    completedStepsCount: number;
+    variant: OnboardingCardVariant;
+    tutorialLink?: string;
+    isResolved?: boolean;
     toggleStepComplete: (step: OnboardingStep) => void;
     getStepIndex: (step: OnboardingStepId) => number;
     isStepComplete: (step: OnboardingStep) => boolean;
-    trackingFn: OnboardingTrackingFn;
+    track: OnboardingTrackFn;
 }
 declare const OnboardingContext: import("react").Context<OnboardingContext | undefined>;
-interface OnboardingProviderProps {
-    children: ReactNode;
-    variant: OnboardingCardVariant;
-    onComplete?: () => void;
-    trackingFn: OnboardingTrackingFn;
-}
-export declare function OnboardingProvider(props: OnboardingProviderProps): JSX.Element;
 export declare const useOnboardingContext: () => OnboardingContext;
 export {};

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

@@ -1,3 +1,4 @@
-import type { OnboardingStep } from "./types";
+import type { OnboardingFramework, OnboardingStep } from "./types";
 export declare const onboardingSteps: OnboardingStep[];
 export declare const onboardingExperimentSteps: OnboardingStep[];
+export declare const tutorialLinks: Record<OnboardingFramework, string>;

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

@@ -1 +1,2 @@
 export { OnboardingGuide } from "./OnboardingGuide";
+export type { OnboardingState, OnboardingStepId } from "./types";

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { z } from "zod";
-export declare const onboardingStepStatusesSchema: z.ZodObject<{
-    createProject: z.ZodLiteral<true>;
+declare const onboardingStepStatusesSchema: z.ZodObject<{
+    createProject: z.ZodBoolean;
     createPageType: z.ZodBoolean;
     codePage: z.ZodBoolean;
     createSlice: z.ZodBoolean;
@@ -9,7 +9,7 @@ export declare const onboardingStepStatusesSchema: z.ZodObject<{
     createContent: z.ZodBoolean;
     renderPage: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
-    createProject: true;
+    createProject: boolean;
     createPageType: boolean;
     codePage: boolean;
     createSlice: boolean;
@@ -17,7 +17,7 @@ export declare const onboardingStepStatusesSchema: z.ZodObject<{
     createContent: boolean;
     renderPage: boolean;
 }, {
-    createProject: true;
+    createProject: boolean;
     createPageType: boolean;
     codePage: boolean;
     createSlice: boolean;
@@ -25,7 +25,7 @@ export declare const onboardingStepStatusesSchema: z.ZodObject<{
     createContent: boolean;
     renderPage: boolean;
 }>;
-export type OnboardingStepStatuses = z.infer<typeof onboardingStepStatusesSchema>;
+type OnboardingStepStatuses = z.infer<typeof onboardingStepStatusesSchema>;
 export type OnboardingStepId = keyof OnboardingStepStatuses;
 export interface OnboardingStep {
     id: OnboardingStepId;
@@ -35,5 +35,11 @@ export interface OnboardingStep {
     videoUrl?: string;
     defaultCompleted?: boolean;
 }
+export type OnboardingState = {
+    completedSteps: OnboardingStepId[];
+    isResolved: boolean;
+};
 export type OnboardingCardVariant = "default" | "light" | "dark";
-export type OnboardingTrackingFn = (args: Record<string, string>) => void;
+export type OnboardingFramework = "next" | "nuxt" | "sveltekit" | "other";
+export type OnboardingTrackFn = (args: Record<string, string>) => void;
+export {};