@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.6 → 0.4.49-alpha.feat-onboarding-guide.9

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,8 +1,11 @@
 /// <reference types="react" />
 import { type ConfettiConfig } from "dom-confetti";
-import type { OnboardingTracking } from "./types";
+import type { OnboardingState, OnboardingStepId, OnboardingToggleResult, OnboardingToggleStepResult, OnboardingTracking } from "./types";
 interface OnboardingGuideProps {
     tracking: OnboardingTracking;
+    fetchOnboarding: () => Promise<OnboardingState>;
+    toggleOnboardingStep: (stepId: OnboardingStepId) => Promise<OnboardingToggleStepResult>;
+    toggleOnboardingGuide: () => Promise<OnboardingToggleResult>;
 }
 export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element;
 export declare function useConfetti(confettiConfig: ConfettiConfig): {

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

@@ -1,7 +1,9 @@
 /// <reference types="react" />
-import type { OnboardingTracking } from "../types";
+import type { OnboardingState, OnboardingStepId, OnboardingToggleStepResult, OnboardingTracking } from "../types";
 interface OnboardingCardProps {
     tracking: OnboardingTracking;
+    fetchOnboarding: () => Promise<OnboardingState>;
+    toggleOnboardingStep: (stepId: OnboardingStepId) => Promise<OnboardingToggleStepResult>;
     onClose?: () => void;
 }
 export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;

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

@@ -1,7 +1,9 @@
 /// <reference types="react" />
-import type { OnboardingTracking } from "../types";
+import type { OnboardingState, OnboardingStepId, OnboardingToggleStepResult, OnboardingTracking } from "../types";
 interface OnboardingProgressStepperProps {
     tracking: OnboardingTracking;
+    fetchOnboarding: () => Promise<OnboardingState>;
+    toggleOnboardingStep: (stepId: OnboardingStepId) => Promise<OnboardingToggleStepResult>;
 }
 export declare function OnboardingProgressStepper(props: OnboardingProgressStepperProps): JSX.Element | null;
 export {};

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

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

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

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

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { z } from "zod";
-declare const onboardingStepIds: readonly ["createProject", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"];
-export declare const onboardingStepIdSchema: z.ZodEnum<["createProject", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>;
+declare const onboardingStepIds: readonly ["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"];
+export declare const onboardingStepIdSchema: z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>;
 export type OnboardingStepId = typeof onboardingStepIds[number];
 export interface OnboardingStep {
     id: OnboardingStepId;
@@ -9,46 +9,54 @@ export interface OnboardingStep {
     description: string;
     content?: JSX.Element;
     videoUrl?: string;
-    defaultCompleted?: boolean;
 }
-export type OnboardingState = {
-    completedSteps: OnboardingStepId[];
-    isDismissed: boolean;
-    context?: {
-        framework: OnboardingFramework;
-        starterId?: string;
-    };
-};
 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">;
+    completedSteps: z.ZodArray<z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
     isDismissed: z.ZodBoolean;
-    context: z.ZodOptional<z.ZodObject<{
+    context: z.ZodObject<{
         framework: z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>;
-        starterId: z.ZodOptional<z.ZodString>;
+        starterId: z.ZodNullable<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         framework: "next" | "nuxt" | "sveltekit" | "other";
-        starterId?: string | undefined;
+        starterId: string | null;
     }, {
         framework: "next" | "nuxt" | "sveltekit" | "other";
-        starterId?: string | undefined;
-    }>>;
+        starterId: string | null;
+    }>;
 }, "strip", z.ZodTypeAny, {
-    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
     isDismissed: boolean;
-    context?: {
+    context: {
         framework: "next" | "nuxt" | "sveltekit" | "other";
-        starterId?: string | undefined;
-    } | undefined;
+        starterId: string | null;
+    };
 }, {
-    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
     isDismissed: boolean;
-    context?: {
+    context: {
         framework: "next" | "nuxt" | "sveltekit" | "other";
-        starterId?: string | undefined;
-    } | undefined;
+        starterId: string | null;
+    };
+}>;
+export type OnboardingState = z.infer<typeof onboardingStateSchema>;
+export declare const onboardingToggleStepResultSchema: z.ZodObject<{
+    completedSteps: z.ZodArray<z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+}, {
+    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+}>;
+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 type OnboardingTrackSource = "PageBuilder" | "SliceMachine";
 export type OnboardingTrackEvent = {
     event: "onboarding:step-completed";

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

@@ -1,14 +1,18 @@
-import { type OnboardingStepId, type OnboardingTracking } from "../OnboardingGuide/types";
-export declare function useOnboarding(): {
+import { type AuthStrategy } from "../../EditorConfig";
+import { type OnboardingState, type OnboardingStepId, type OnboardingToggleResult, type OnboardingToggleStepResult, type OnboardingTracking } from "../OnboardingGuide/types";
+export declare function useOnboarding(fetcher: () => Promise<OnboardingState>): {
     steps: import("../OnboardingGuide/types").OnboardingStep[];
     context: {
         framework: "next" | "nuxt" | "sveltekit" | "other";
-        starterId?: string | undefined;
-    } | undefined;
-    completedSteps: ("createProject" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+        starterId: string | null;
+    };
+    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "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 function useToggleOnboardingStep(fetcher: () => Promise<OnboardingState>, stepToggler: (stepId: OnboardingStepId) => Promise<OnboardingToggleStepResult>): (stepId: OnboardingStepId, tracking: OnboardingTracking) => Promise<void>;
+export declare function useToggleOnboarding(fetcher: () => Promise<OnboardingState>, guideToggler: () => Promise<OnboardingToggleResult>): () => Promise<void>;
+export declare function getOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingState>;
+export declare function toggleOnboardingStep(stepId: OnboardingStepId, baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleStepResult>;
+export declare function toggleOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleResult>;