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

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

@@ -1,18 +1,83 @@
+/// <reference types="react" />
+import { z } from "zod";
 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[];
+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;
+    title: string;
+    description: string;
+    content?: JSX.Element;
+    videoUrl?: 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<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "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: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    isDismissed: boolean;
     context: {
         framework: "next" | "nuxt" | "sveltekit" | "other";
         starterId: string | null;
     };
+}, {
     completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
-    completedStepsCount: number;
-    isOnboardingCompleted: boolean;
     isDismissed: boolean;
-};
-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>;
+    context: {
+        framework: "next" | "nuxt" | "sveltekit" | "other";
+        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 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>;
+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/repository.d.ts

@@ -80,6 +80,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         slicemachineEnabled: boolean;
     }>>>;
     framework: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>>>;
+    starterId: z.ZodOptional<z.ZodString>;
     storageVersion: z.ZodObject<{
         major: z.ZodNumber;
         minor: z.ZodNumber;
@@ -112,6 +113,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         minor: number;
     };
     simulator_url?: string | null | undefined;
+    starterId?: string | undefined;
 }, {
     languages: {
         id: string;
@@ -134,7 +136,9 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         slicemachineEnabled: boolean;
     } | undefined;
     framework?: unknown;
+    starterId?: string | undefined;
 }>, {
+    framework: "next" | "nuxt" | "sveltekit" | "other";
     simulatorUrl: string | undefined;
     isSupportedFramework: boolean;
     authors: {
@@ -156,6 +160,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         major: number;
         minor: number;
     };
+    starterId?: string | undefined;
 }, {
     languages: {
         id: string;
@@ -178,6 +183,7 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         slicemachineEnabled: boolean;
     } | undefined;
     framework?: unknown;
+    starterId?: string | undefined;
 }>;
 export type Repository = z.TypeOf<typeof repositorySchema>;
 export declare function getRepository(baseUrl: URL, authStrategy: AuthStrategy): Promise<Repository>;

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

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import type { AuthStrategy } from "../../EditorConfig";
+import { type AuthStrategy } from "../../EditorConfig";
 declare const repositoryRole: z.ZodUnion<[z.ZodEnum<["Owner", "Administrator", "Writer", "Manager", "Readonly"]>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodEnum<["Owner", "Administrator", "Writer", "Manager", "Readonly"]>>>]>;
 export declare const roleMap: {
     readonly SuperUser: "SuperUser";
@@ -53,4 +53,16 @@ export declare const profileResponse: z.ZodObject<{
 }>;
 export type Profile = z.infer<typeof profileResponse>;
 export declare function getProfile(userServiceBaseUrl: URL, authStrategy: AuthStrategy): Promise<Profile>;
+export declare function useProfile(): {
+    email: string;
+    shortId: string;
+    intercomHash: string;
+    firstName: string;
+    lastName: string;
+    superPower: boolean;
+    repositories: {
+        domain: string;
+        role: ("Owner" | "Administrator" | "Writer" | "Manager" | "Readonly" | Record<string, "Owner" | "Administrator" | "Writer" | "Manager" | "Readonly" | undefined>) & ("Owner" | "Administrator" | "Writer" | "Manager" | "Readonly" | Record<string, "Owner" | "Administrator" | "Writer" | "Manager" | "Readonly" | undefined> | undefined);
+    }[];
+};
 export {};

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

@@ -30,6 +30,7 @@ export declare function useDocuments(params: {
                 first_name?: string | undefined;
                 last_name?: string | undefined;
                 email?: string | undefined;
+                uploadedAvatar?: string | undefined;
             };
             version_id: string;
             custom_type_label: string;
@@ -56,6 +57,7 @@ export declare function useDocuments(params: {
                     first_name?: string | undefined;
                     last_name?: string | undefined;
                     email?: string | undefined;
+                    uploadedAvatar?: string | undefined;
                 };
                 version_id: string;
                 custom_type_label: string;

package/dist/fields/LinkField/LinkDescriptionCard.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { type IconName } from "@prismicio/editor-ui";
+export interface LinkDescriptionCardProps {
+    url?: URL | string;
+    title?: string;
+    subTitle?: string;
+    description?: string;
+    largeIconName?: IconName;
+    loading?: boolean;
+    error?: boolean;
+    onEdit?: () => void;
+    onUnlink?: () => void;
+}
+export declare function LinkDescriptionCard(props: LinkDescriptionCardProps): JSX.Element;

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

@@ -1,13 +1,30 @@
 /// <reference types="react" />
-import type { LinkContent } from "@prismicio/types-internal/lib/content";
+import { FilledLinkContent, type LinkContent } from "@prismicio/types-internal/lib/content";
 import type { Link } from "@prismicio/types-internal/lib/customtypes";
+import { type FieldSelectType } from "./LinkFieldActions";
 interface LinkFieldProps {
     id?: string;
     field: Link;
-    readOnly?: boolean;
     content: LinkContent | undefined;
     condensedButtons?: boolean;
     onContentChange: (content: LinkContent | undefined) => void;
 }
 export declare function LinkField(props: LinkFieldProps): JSX.Element;
+interface GetFieldIconArgs {
+    selectType?: FieldSelectType;
+    displayTextEnabled?: boolean;
+}
+export declare function getFieldIcon(args: GetFieldIconArgs): "image" | "description" | "link" | "notes" | "public";
+interface FilledLinkFieldProps {
+    id?: string;
+    condensedButtons?: boolean;
+    field: Link & {
+        config?: {
+            allowText?: false;
+        };
+    };
+    content: FilledLinkContent | undefined;
+    onContentChange: (content: FilledLinkContent | undefined) => void;
+}
+export declare function FilledLinkField(props: FilledLinkFieldProps): JSX.Element;
 export {};

package/dist/fields/LinkField/LinkFieldActions.d.ts

@@ -1,14 +1,17 @@
 /// <reference types="react" />
-export type FieldSelectTypes = "web" | "document" | "media";
+export type FieldSelectType = "web" | "document" | "media" | "any";
 interface Props {
     hasLink: boolean;
     onUnlink: () => void;
-    selectedType?: FieldSelectTypes;
+    selectedType?: FieldSelectType;
     selectEnabled: boolean;
-    onValueChange: (newValue: FieldSelectTypes) => void;
+    value: string;
+    onOpenLinkModal: () => void;
+    onValueChange: (newValue: FieldSelectType) => void;
     openInNewTab?: boolean;
     condensedButtons?: boolean;
-    setOpenInNewTab?: (open: boolean) => void;
+    showNewTabButton?: boolean;
+    displayTextEnabled: boolean;
 }
 export declare function LinkFieldActions(props: Props): JSX.Element;
 export {};

package/dist/fields/LinkField/LinkImageCard.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+export interface LinkImageCardProps {
+    url: string;
+    title: string;
+    subTitle: string;
+    onEdit?: () => void;
+    onUnlink?: () => void;
+}
+export declare function LinkImageCard(props: LinkImageCardProps): JSX.Element;

package/dist/fields/LinkField/WebLinks/WebLinkModal.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+interface WebLinkModalProps {
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    url: string;
+    openInNewTab: boolean;
+    showNewTabButton: boolean;
+    onUpdate: (newUrl: string, newTab: boolean) => void;
+}
+export declare function WebLinkModal(props: WebLinkModalProps): JSX.Element;
+export {};

package/dist/fields/LinkField/index.d.ts

@@ -1,3 +1,5 @@
-export { LinkField } from "./LinkField";
+export { LinkDescriptionCard } from "./LinkDescriptionCard";
+export { FilledLinkField, LinkField } from "./LinkField";
 export { LinkFieldActions } from "./LinkFieldActions";
+export { LinkImageCard } from "./LinkImageCard";
 export { mapMediaToLinkContent } from "./useLinkField";

package/dist/fields/LinkField/useLinkField.d.ts

@@ -1,28 +1,30 @@
 /// <reference types="react" />
 import type { ErrorBoundary } from "@prismicio/editor-ui";
-import type { LinkContent } from "@prismicio/types-internal/lib/content";
+import { type LinkContent } from "@prismicio/types-internal/lib/content";
 import type { Link } from "@prismicio/types-internal/lib/customtypes";
 import type { MediaAssetOrExternalImage } from "../../core/MediaLibrary/hooks/mediaLibraryData";
-import type { FieldSelectTypes } from "./LinkFieldActions";
+import type { FieldSelectType } from "./LinkFieldActions";
 interface useLinkFieldParams {
     field: Link;
     content: LinkContent | undefined;
     onContentChange: (content: LinkContent | undefined) => void;
 }
 export declare function useLinkField(params: useLinkFieldParams): {
-    contentType: "ImageLink" | "FileLink" | "DocumentLink" | "ExternalLink" | undefined;
-    selectType: "document" | "media" | "web" | undefined;
+    contentType: "DocumentLink" | "ImageLink" | "FileLink" | "ExternalLink" | "MediaLink" | "AnyLink" | undefined;
+    selectType: "document" | "media" | "web" | "any" | undefined;
     fieldValue: string;
-    onValueChange: (value: string) => void;
-    onTypeChange: (newValue: FieldSelectTypes) => void;
+    onDisplayTextChange: (displayText: string) => void;
+    onValueChange: (value: string, newTab?: boolean) => void;
+    onTypeChange: (newValue?: FieldSelectType) => void;
     placeholder: string;
     isTypeSelectEnabled: boolean;
     onDocumentSelected: (documentId: string) => void;
     onError: () => void;
     errorBoundaryRef: import("react").RefObject<ErrorBoundary>;
     isTargetNewTab: boolean;
-    updateWebLinkTarget: (newTab: boolean) => void;
-    onMediaSelected: (media: MediaAssetOrExternalImage) => void;
+    onMediaSelected: (newMedia: MediaAssetOrExternalImage) => void;
+    displayTextEnabled: boolean;
+    displayText: string;
 };
 export declare function useDocumentTitle(id: string): string;
 interface MapMediaToLinkContentArgs {
@@ -60,7 +62,7 @@ export declare function mapMediaToLinkContent(args: MapMediaToLinkContentArgs):
         __TYPE__: "ImageLink";
         id: string;
         name: string;
-        kind: string;
+        kind: "image";
         url: string;
         size: string;
         height: string;

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

@@ -11,27 +11,25 @@ declare const _default: {
                     data: ({
                         __TYPE__: "ImageLink";
                     } & {
+                        kind: string;
                         id: string;
                         url: string;
                         height: string;
                         width: string;
                         size: string;
                         name: string;
-                        kind: string;
                     } & {
                         date?: string | null | undefined;
                     }) | ({
+                        __TYPE__: "FileLink";
+                    } & {
+                        kind: string;
                         id: string;
                         url: string;
                         name: string;
-                        kind: string;
                         size: string;
                     } & {
                         date?: string | null | undefined;
-                    } & {
-                        __TYPE__: "FileLink";
-                    } & {
-                        size?: string | undefined;
                     }) | ({
                         __TYPE__: "DocumentLink";
                     } & {
@@ -74,27 +72,25 @@ declare const _default: {
                     data: ({
                         __TYPE__: "ImageLink";
                     } & {
+                        kind: string;
                         id: string;
                         url: string;
                         height: string;
                         width: string;
                         size: string;
                         name: string;
-                        kind: string;
                     } & {
                         date?: string | null | undefined;
                     }) | ({
+                        __TYPE__: "FileLink";
+                    } & {
+                        kind: string;
                         id: string;
                         url: string;
                         name: string;
-                        kind: string;
                         size: string;
                     } & {
                         date?: string | null | undefined;
-                    } & {
-                        __TYPE__: "FileLink";
-                    } & {
-                        size?: string | undefined;
                     }) | ({
                         __TYPE__: "DocumentLink";
                     } & {