@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.6 → 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/types.d.ts

@@ -11,44 +11,37 @@ export interface OnboardingStep {
     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">;
     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")[];
     isDismissed: boolean;
-    context?: {
+    context: {
         framework: "next" | "nuxt" | "sveltekit" | "other";
-        starterId?: string | undefined;
-    } | undefined;
+        starterId: string | null;
+    };
 }, {
     completedSteps: ("createProject" | "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 type OnboardingTrackSource = "PageBuilder" | "SliceMachine";
 export type OnboardingTrackEvent = {
     event: "onboarding:step-completed";

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

@@ -1,10 +1,23 @@
+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 | undefined;
-    } | undefined;
+        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;
@@ -12,3 +25,48 @@ export declare function useOnboarding(): {
 };
 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 {};