@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.5 → 0.4.49-alpha.feat-onboarding-guide.7

package/dist/EditorConfig.d.ts

@@ -6,7 +6,7 @@ export type EditorConfig = {
     unsplashApiBaseUrl: URL;
     authStrategy: AuthStrategy;
 } & OptionalConfigs;
-type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig;
+type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig & RepositoryConfig;
 type MediaLibrary = {
     mediaLibrary?: never;
 } | {
@@ -52,6 +52,12 @@ interface LayoutConfig {
      */
     scrollOffsetTop?: number;
 }
+type RepositoryConfig = {
+    repositoryBaseUrl?: never;
+} | {
+    repository: string;
+    repositoryBaseUrl: URL;
+};
 interface OnAnalyticsEvent {
     (event: "Media Library Search", args: {
         assetType: MediaAssetType;

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

@@ -1,24 +1,19 @@
 /// <reference types="react" />
-import { type EditorConfig } from "../../EditorConfig";
-import type { OnboardingCardVariant, OnboardingTrackingFn } from "./types";
+import { type ConfettiConfig } from "dom-confetti";
+import type { OnboardingTracking } from "./types";
 interface OnboardingGuideProps {
-    config: EditorConfig;
-    /**
-     * Whether the whole guide (including 'Get started' button) should be visible
-     *
-     * Example usage: we hide it on small screens in SM
-     * @default true
-     */
-    isOnboardingVisible?: boolean;
-    /**
-     * A/B test onboarding card visibility experiment variant
-     * @default "default"
-     */
-    variant?: OnboardingCardVariant;
-    /** Link to the video tutorials */
-    tutorialLink?: string;
-    /** Function to track onboarding events */
-    trackingFn: OnboardingTrackingFn;
+    tracking: OnboardingTracking;
 }
 export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element;
+export declare function useConfetti(confettiConfig: ConfettiConfig): {
+    throwConfetti: () => void;
+    confettiCannonRef: import("react").RefObject<HTMLDivElement>;
+    confettiContainerRef: import("react").RefObject<HTMLDivElement>;
+};
+export declare function useFadeOut(closeGuide: () => void, startDelay: number, endDelay: number): {
+    isFadedOut: boolean;
+    isFading: boolean;
+    fadeOut: () => void;
+    resetFadeOut: () => void;
+};
 export {};

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

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

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant } from "../types";
+import type { OnboardingTracking } from "../types";
 interface OnboardingProgressStepperProps {
-    variant: OnboardingCardVariant;
+    tracking: OnboardingTracking;
 }
 export declare function OnboardingProgressStepper(props: OnboardingProgressStepperProps): JSX.Element | null;
 export {};

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

@@ -1,8 +1,6 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant } from "../types";
 interface OnboardingTutorialProps {
     href: string;
-    variant?: OnboardingCardVariant;
 }
 export declare function OnboardingTutorial(props: OnboardingTutorialProps): JSX.Element;
 export {};

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

@@ -1,3 +1,6 @@
-import type { OnboardingStep } from "./types";
-export declare const onboardingSteps: OnboardingStep[];
-export declare const onboardingExperimentSteps: OnboardingStep[];
+import type { OnboardingFramework, OnboardingStep } from "./types";
+export declare function getOnboardingContent(framework?: OnboardingFramework): {
+    steps: OnboardingStep[];
+    defaultCompletedStepIds: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    tutorialLink: string;
+};

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

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

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

@@ -1,32 +1,8 @@
 /// <reference types="react" />
 import { z } from "zod";
-export declare const onboardingStepStatusesSchema: z.ZodObject<{
-    createProject: z.ZodLiteral<true>;
-    createPageType: z.ZodBoolean;
-    codePage: z.ZodBoolean;
-    createSlice: z.ZodBoolean;
-    reviewAndPush: z.ZodBoolean;
-    createContent: z.ZodBoolean;
-    renderPage: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    createProject: true;
-    createPageType: boolean;
-    codePage: boolean;
-    createSlice: boolean;
-    reviewAndPush: boolean;
-    createContent: boolean;
-    renderPage: boolean;
-}, {
-    createProject: true;
-    createPageType: boolean;
-    codePage: boolean;
-    createSlice: boolean;
-    reviewAndPush: boolean;
-    createContent: boolean;
-    renderPage: boolean;
-}>;
-export type OnboardingStepStatuses = z.infer<typeof onboardingStepStatusesSchema>;
-export type OnboardingStepId = keyof OnboardingStepStatuses;
+declare const onboardingStepIds: readonly ["createProject", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"];
+export declare const onboardingStepIdSchema: z.ZodEnum<["createProject", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>;
+export type OnboardingStepId = typeof onboardingStepIds[number];
 export interface OnboardingStep {
     id: OnboardingStepId;
     title: string;
@@ -35,5 +11,54 @@ export interface OnboardingStep {
     videoUrl?: string;
     defaultCompleted?: boolean;
 }
-export type OnboardingCardVariant = "default" | "light" | "dark";
-export type OnboardingTrackingFn = (args: Record<string, string>) => void;
+declare const onboardingFrameworks: readonly ["next", "nuxt", "sveltekit", "other"];
+export type OnboardingFramework = typeof onboardingFrameworks[number];
+export declare const onboardingStateSchema: z.ZodObject<{
+    completedSteps: z.ZodArray<z.ZodEnum<["createProject", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
+    isDismissed: z.ZodBoolean;
+    context: z.ZodObject<{
+        framework: z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>;
+        starterId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    }, {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    isDismissed: boolean;
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+}, {
+    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    isDismissed: boolean;
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+}>;
+export type OnboardingState = z.infer<typeof onboardingStateSchema>;
+export type OnboardingTrackSource = "PageBuilder" | "SliceMachine";
+export type OnboardingTrackEvent = {
+    event: "onboarding:step-completed";
+    stepId: OnboardingStepId;
+    stepTitle: string;
+    source: OnboardingTrackSource;
+} | {
+    event: "onboarding:step-opened";
+    stepId: OnboardingStepId;
+    stepTitle: string;
+    source: OnboardingTrackSource;
+} | {
+    event: "onboarding:completed";
+    source: OnboardingTrackSource;
+};
+export interface OnboardingTracking {
+    track: (args: OnboardingTrackEvent) => void;
+    source: OnboardingTrackSource;
+}
+export {};

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

@@ -1,4 +1,5 @@
 export * from "./customType";
 export * from "./document";
+export * from "./onboarding";
 export * from "./repository";
 export * from "./user";

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

@@ -0,0 +1,72 @@
+import { z } from "zod";
+import { type AuthStrategy } from "../../EditorConfig";
+import { type OnboardingStepId, type OnboardingTracking } from "../OnboardingGuide/types";
+export declare function useOnboarding(): {
+    steps: import("../OnboardingGuide/types").OnboardingStep[];
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedStepsCount: number;
+    isOnboardingCompleted: boolean;
+    isDismissed: boolean;
+};
+export declare function useOnboardingToggleStep(): {
+    steps: import("../OnboardingGuide/types").OnboardingStep[];
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedStepsCount: number;
+    isOnboardingCompleted: boolean;
+    isDismissed: boolean;
+};
+export declare function useToggleStep(): (stepId: OnboardingStepId, tracking: OnboardingTracking) => Promise<void>;
+export declare function useToggleOnboarding(): () => Promise<void>;
+export declare const Onboarding: z.ZodObject<{
+    completedSteps: z.ZodArray<z.ZodString, "many">;
+    isDismissed: z.ZodBoolean;
+    context: z.ZodObject<{
+        framework: z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>;
+        starterId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    }, {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    completedSteps: string[];
+    isDismissed: boolean;
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+}, {
+    completedSteps: string[];
+    isDismissed: boolean;
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+}>;
+type Onboarding = z.infer<typeof Onboarding>;
+export declare function getOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<Onboarding>;
+export declare const OnboardingToggleStepResult: z.ZodObject<{
+    completedSteps: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    completedSteps: string[];
+}, {
+    completedSteps: string[];
+}>;
+export declare const OnboardingToggleResult: z.ZodObject<{
+    isDismissed: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    isDismissed: boolean;
+}, {
+    isDismissed: boolean;
+}>;
+export {};

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

@@ -98,6 +98,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         lastname?: string | undefined;
         uploadedAvatar?: string | undefined;
     }[];
+    framework: "next" | "nuxt" | "sveltekit" | "other";
     languages: {
         id: string;
         name: string;
@@ -106,7 +107,6 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     quotas: {
         slicemachineEnabled: boolean;
     };
-    framework: "next" | "nuxt" | "sveltekit" | "other";
     storageVersion: {
         major: number;
         minor: number;