@prismicio/editor-fields 0.4.49 → 0.4.50-shared-onboarding-in-page-builder.1

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,7 +91,9 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         major: number;
         minor: number;
     }>;
+    uploadedAvatar: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    framework: "next" | "nuxt" | "sveltekit" | "other";
     authors: {
         id: string;
         email: string;
@@ -107,13 +109,13 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     quotas: {
         slicemachineEnabled: boolean;
     };
-    framework: "next" | "nuxt" | "sveltekit" | "other";
     storageVersion: {
         major: number;
         minor: number;
     };
     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>;

package/dist/fields/LinkField/Documents/documentsData.d.ts

@@ -25,7 +25,6 @@ export declare function useDocuments(params: {
         } | {
             status: "archived";
         }) & {
-            tags: string[];
             author: {
                 first_name?: string | undefined;
                 last_name?: string | undefined;
@@ -33,6 +32,7 @@ export declare function useDocuments(params: {
                 uploadedAvatar?: string | undefined;
             };
             version_id: string;
+            tags: string[];
             custom_type_label: string;
             last_modified_date: Date;
             preview_summary?: string | undefined;
@@ -52,7 +52,6 @@ export declare function useDocuments(params: {
             } | {
                 status: "archived";
             }) & {
-                tags: string[];
                 author: {
                     first_name?: string | undefined;
                     last_name?: string | undefined;
@@ -60,6 +59,7 @@ export declare function useDocuments(params: {
                     uploadedAvatar?: string | undefined;
                 };
                 version_id: string;
+                tags: string[];
                 custom_type_label: string;
                 last_modified_date: Date;
                 preview_summary?: string | undefined;

package/dist/fields/RichTextField/coreExtensions/ListItem.d.ts

@@ -3,7 +3,7 @@ declare const _default: {
     component: import("@tiptap/core").Node<import("@tiptap/extension-list-item").ListItemOptions, any>;
     converter: {
         fromPrismic(schema: Schema<any, any>): (list: {
-            type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
+            type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
             content: {
                 text: string;
             } & {
@@ -64,7 +64,7 @@ declare const _default: {
             direction?: string | undefined;
         }) => ProsemirrorNode | undefined;
         toPrismic(node: ProsemirrorNode, nodeType: "list-item" | "o-list-item"): readonly ({
-            type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
+            type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
             content: {
                 text: string;
             } & {