@prismicio/editor-fields 0.4.49 → 0.4.50

package/dist/constants/framework.d.ts

@@ -0,0 +1,6 @@
+export declare const frameworkLabels: {
+    readonly next: "Next.js";
+    readonly nuxt: "Nuxt";
+    readonly sveltekit: "SvelteKit";
+    readonly other: "Other";
+};

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

@@ -1,22 +1,10 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant, OnboardingTrackingFn } from "./types";
+import type { OnboardingState, OnboardingTracking } from "../service";
 interface OnboardingGuideProps {
-    /**
-     * 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;
+    onboardingState: OnboardingState;
+    tracking: OnboardingTracking;
+    onToggleStep: (stepId: string) => Promise<string[]>;
+    onToggleGuide: () => Promise<void>;
 }
-export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element;
+export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element | null;
 export {};

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

@@ -1,8 +1,11 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant } from "../types";
+import type { OnboardingStep, OnboardingTracking } from "../../service";
 interface OnboardingCardProps {
-    variant: OnboardingCardVariant;
+    steps: OnboardingStep[];
+    completedSteps: string[];
     tutorialLink?: string;
+    tracking: OnboardingTracking;
+    onToggleStep: (step: OnboardingStep) => Promise<void>;
     onClose?: () => void;
 }
 export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;

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

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

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

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

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 "../service/onboarding";
+export declare function getOnboardingContent(framework?: OnboardingFramework, starter?: string | null): {
+    steps: OnboardingStep[];
+    defaultCompletedStepIds: string[];
+    tutorialLink: string | undefined;
+};

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,79 @@
+/// <reference types="react" />
+import { z } from "zod";
+import { type AuthStrategy } from "../../EditorConfig";
+export interface OnboardingStep {
+    id: string;
+    title: string;
+    description: string;
+    content?: JSX.Element;
+    videoUrl?: string;
+    defaultCompleted?: boolean;
+}
+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>>>;
+        starterId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    }, {
+        starterId: string | null;
+        framework?: unknown;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    completedSteps: string[];
+    isDismissed: boolean;
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        starterId: string | null;
+    };
+}, {
+    completedSteps: string[];
+    isDismissed: boolean;
+    context: {
+        starterId: string | null;
+        framework?: unknown;
+    };
+}>;
+export type OnboardingState = z.infer<typeof onboardingStateSchema>;
+export type OnboardingFramework = OnboardingState["context"]["framework"];
+export declare const onboardingToggleStepResultSchema: z.ZodObject<{
+    completedSteps: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    completedSteps: string[];
+}, {
+    completedSteps: string[];
+}>;
+export type OnboardingToggleStepResult = z.infer<typeof onboardingToggleStepResultSchema>;
+export declare const onboardingToggleResultSchema: z.ZodObject<{
+    isDismissed: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    isDismissed: boolean;
+}, {
+    isDismissed: boolean;
+}>;
+export type OnboardingToggleResult = z.infer<typeof onboardingToggleResultSchema>;
+export declare function getOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingState>;
+export declare function toggleOnboardingStep(stepId: string, baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleStepResult>;
+export declare function toggleOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleResult>;
+export type OnboardingTrackSource = "PageBuilder" | "SliceMachine";
+export type OnboardingTrackEvent = {
+    event: "shared-onboarding:step-completed";
+    stepId: string;
+    stepTitle: string;
+    source: OnboardingTrackSource;
+} | {
+    event: "shared-onboarding:step-opened";
+    stepId: string;
+    stepTitle: string;
+    source: OnboardingTrackSource;
+} | {
+    event: "shared-onboarding:completed";
+    source: OnboardingTrackSource;
+};
+export interface OnboardingTracking {
+    track: (args: OnboardingTrackEvent) => void | Promise<void>;
+    source: OnboardingTrackSource;
+}

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

@@ -28,7 +28,7 @@ declare const repositoryQuotas: z.ZodObject<{
     slicemachineEnabled: boolean;
 }>;
 export type RepositoryQuotas = z.TypeOf<typeof repositoryQuotas>;
-declare const repositoryFramework: z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>;
+export declare const repositoryFramework: z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>;
 export type RepositoryFramework = z.TypeOf<typeof repositoryFramework>;
 declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     simulator_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -91,6 +91,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         major: number;
         minor: number;
     }>;
+    uploadedAvatar: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     authors: {
         id: string;
@@ -114,6 +115,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     };
     simulator_url?: string | null | undefined;
     starterId?: string | undefined;
+    uploadedAvatar?: string | undefined;
 }, {
     languages: {
         id: string;
@@ -137,6 +139,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     } | undefined;
     framework?: unknown;
     starterId?: string | undefined;
+    uploadedAvatar?: string | undefined;
 }>, {
     framework: "next" | "nuxt" | "sveltekit" | "other";
     simulatorUrl: string | undefined;
@@ -161,6 +164,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         minor: number;
     };
     starterId?: string | undefined;
+    uploadedAvatar?: string | undefined;
 }, {
     languages: {
         id: string;
@@ -184,6 +188,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     } | undefined;
     framework?: unknown;
     starterId?: string | undefined;
+    uploadedAvatar?: string | undefined;
 }>;
 export type Repository = z.TypeOf<typeof repositorySchema>;
 export declare function getRepository(baseUrl: URL, authStrategy: AuthStrategy): Promise<Repository>;