@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.14 → 0.4.49-alpha.feat-onboarding-guide.16

package/dist/core/MediaLibrary/hooks/mediaLibraryData.d.ts

@@ -54,8 +54,8 @@ export declare const mediaAssetType: z.ZodObject<{
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    size: number;
     id: string;
+    size: number;
     url: string;
     tags: {
         id: string;
@@ -82,8 +82,8 @@ export declare const mediaAssetType: z.ZodObject<{
         credits?: string | undefined;
     } | undefined;
 }, {
-    size: number;
     id: string;
+    size: number;
     url: string;
     tags: {
         id: string;
@@ -169,8 +169,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
-        size: number;
         id: string;
+        size: number;
         url: string;
         tags: {
             id: string;
@@ -197,8 +197,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
             credits?: string | undefined;
         } | undefined;
     }, {
-        size: number;
         id: string;
+        size: number;
         url: string;
         tags: {
             id: string;
@@ -228,8 +228,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
-        size: number;
         id: string;
+        size: number;
         url: string;
         tags: {
             id: string;
@@ -260,8 +260,8 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, {
     total: number;
     items: {
-        size: number;
         id: string;
+        size: number;
         url: string;
         tags: {
             id: string;
@@ -308,8 +308,8 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     page: number;
     total: number;
     items: {
-        size: number;
         id: string;
+        size: number;
         url: string;
         tags: {
             id: string;
@@ -357,8 +357,8 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
     media: {
-        size: number;
         id: string;
+        size: number;
         url: string;
         tags: {
             id: string;
@@ -407,8 +407,8 @@ declare function deleteMedia(mediaIds: string[]): void;
 declare function deleteSearchData(args: MediaLibraryFilters): void;
 type MediaPage = Awaited<ReturnType<typeof searchMedia>>;
 export declare function getMedia(allPages: MediaPage[], keyword: string, assetType: MediaAssetType, uploaderId: string | undefined, tags: string): {
-    size: number;
     id: string;
+    size: number;
     url: string;
     tags: {
         id: string;

package/dist/core/MediaLibrary/hooks/useSelectedMedia.d.ts

@@ -1,6 +1,6 @@
 export declare function useSelectedMedia(): {
-    size: number;
     id: string;
+    size: number;
     url: string;
     tags: {
         id: string;

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

@@ -1,10 +1,10 @@
 /// <reference types="react" />
-import type { OnboardingState, OnboardingStepId, OnboardingTracking } from "../service";
+import type { OnboardingState, OnboardingTracking } from "../service";
 interface OnboardingGuideProps {
     onboardingState: OnboardingState;
     tracking: OnboardingTracking;
-    onToggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
+    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,8 @@
 /// <reference types="react" />
-import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
+import type { OnboardingStep, OnboardingTracking } from "../../service";
 interface OnboardingCardProps {
     steps: OnboardingStep[];
-    completedSteps: OnboardingStepId[];
+    completedSteps: string[];
     tutorialLink?: string;
     tracking: OnboardingTracking;
     onToggleStep: (step: OnboardingStep) => Promise<void>;

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

@@ -1,8 +1,8 @@
 /// <reference types="react" />
-import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
+import type { OnboardingStep, OnboardingTracking } from "../../service";
 interface OnboardingProgressStepperProps {
     steps: OnboardingStep[];
-    completedSteps: OnboardingStepId[];
+    completedSteps: string[];
     onToggleStep: (step: OnboardingStep) => Promise<void>;
     tracking: OnboardingTracking;
 }

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

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

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

@@ -6,21 +6,21 @@ declare const customTypeResponse: z.ZodObject<{
     repeatable: z.ZodBoolean;
     status: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
+    id: string;
     status: boolean;
     label: string;
-    id: string;
     repeatable: boolean;
 }, {
+    id: string;
     status: boolean;
     label: string;
-    id: string;
     repeatable: boolean;
 }>;
 export type CustomTypeResponse = z.TypeOf<typeof customTypeResponse>;
 export declare function getRepositoryCustomTypes(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<{
+    id: string;
     status: boolean;
     label: string;
-    id: string;
     repeatable: boolean;
 }[]>;
 export {};

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

@@ -193,8 +193,8 @@ export declare const documentMetaOkType: z.ZodObject<{
         uid?: string | undefined;
     }>>, "many">;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     id: string;
+    title: string;
     language: {
         id: string;
         name: string;
@@ -363,8 +363,8 @@ declare const getDocumentListSchema: z.ZodObject<{
             uid?: string | undefined;
         }>>, "many">;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         id: string;
+        title: string;
         language: {
             id: string;
             name: string;
@@ -432,10 +432,9 @@ declare const getDocumentListSchema: z.ZodObject<{
         title?: string | null | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    total: number;
     results: {
-        title: string;
         id: string;
+        title: string;
         language: {
             id: string;
             name: string;
@@ -468,9 +467,9 @@ declare const getDocumentListSchema: z.ZodObject<{
             uid?: string | undefined;
         })[];
     }[];
+    total: number;
     cursor?: string | undefined;
 }, {
-    total: number;
     results: {
         id: string;
         language: {
@@ -506,6 +505,7 @@ declare const getDocumentListSchema: z.ZodObject<{
         })[];
         title?: string | null | undefined;
     }[];
+    total: number;
     cursor?: string | undefined;
 }>;
 declare const documentsFullTextSearchAPISchemaOkType: z.ZodObject<{

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

@@ -1,54 +1,50 @@
 /// <reference types="react" />
 import { z } from "zod";
 import { type AuthStrategy } from "../../EditorConfig";
-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;
+    id: string;
     title: string;
     description: string;
     content?: JSX.Element;
     videoUrl?: string;
     defaultCompleted?: boolean;
 }
-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">;
+    completedSteps: z.ZodArray<z.ZodString, "many">;
     isDismissed: z.ZodBoolean;
     context: z.ZodObject<{
-        framework: z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>;
+        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;
     }, {
-        framework: "next" | "nuxt" | "sveltekit" | "other";
         starterId: string | null;
+        framework?: unknown;
     }>;
 }, "strip", z.ZodTypeAny, {
-    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedSteps: string[];
     isDismissed: boolean;
     context: {
         framework: "next" | "nuxt" | "sveltekit" | "other";
         starterId: string | null;
     };
 }, {
-    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedSteps: string[];
     isDismissed: boolean;
     context: {
-        framework: "next" | "nuxt" | "sveltekit" | "other";
         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.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
+    completedSteps: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
-    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedSteps: string[];
 }, {
-    completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
+    completedSteps: string[];
 }>;
 export type OnboardingToggleStepResult = z.infer<typeof onboardingToggleStepResultSchema>;
 export declare const onboardingToggleResultSchema: z.ZodObject<{
@@ -60,17 +56,17 @@ export declare const onboardingToggleResultSchema: z.ZodObject<{
 }>;
 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 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: OnboardingStepId;
+    stepId: string;
     stepTitle: string;
     source: OnboardingTrackSource;
 } | {
     event: "shared-onboarding:step-opened";
-    stepId: OnboardingStepId;
+    stepId: string;
     stepTitle: string;
     source: OnboardingTrackSource;
 } | {
@@ -81,4 +77,3 @@ export interface OnboardingTracking {
     track: (args: OnboardingTrackEvent) => void | Promise<void>;
     source: OnboardingTrackSource;
 }
-export {};

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>>;
@@ -92,7 +92,11 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         minor: number;
     }>;
 }, "strip", z.ZodTypeAny, {
-    framework: "next" | "nuxt" | "sveltekit" | "other";
+    languages: {
+        id: string;
+        name: string;
+        is_master?: boolean | undefined;
+    }[];
     authors: {
         id: string;
         email: string;
@@ -100,14 +104,10 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         lastname?: string | undefined;
         uploadedAvatar?: string | undefined;
     }[];
-    languages: {
-        id: string;
-        name: string;
-        is_master?: boolean | undefined;
-    }[];
     quotas: {
         slicemachineEnabled: boolean;
     };
+    framework: "next" | "nuxt" | "sveltekit" | "other";
     storageVersion: {
         major: number;
         minor: number;
@@ -141,6 +141,11 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
     framework: "next" | "nuxt" | "sveltekit" | "other";
     simulatorUrl: string | undefined;
     isSupportedFramework: boolean;
+    languages: {
+        id: string;
+        name: string;
+        is_master?: boolean | undefined;
+    }[];
     authors: {
         id: string;
         email: string;
@@ -148,11 +153,6 @@ declare const repositorySchema: z.ZodEffects<z.ZodObject<{
         lastname?: string | undefined;
         uploadedAvatar?: string | undefined;
     }[];
-    languages: {
-        id: string;
-        name: string;
-        is_master?: boolean | undefined;
-    }[];
     quotas: {
         slicemachineEnabled: boolean;
     };

package/dist/fields/IntegrationField/integrationData.d.ts

@@ -5,15 +5,15 @@ interface IntegrationCatalogSearchArgs {
 }
 export declare function useIntegrationCatalogSearch(args: IntegrationCatalogSearchArgs): {
     items: {
-        title: string;
         id: string;
+        title: string;
         imageURL?: string | undefined;
         description?: string | undefined;
     }[];
     response: {
         items: {
-            title: string;
             id: string;
+            title: string;
             imageURL?: string | undefined;
             description?: string | undefined;
         }[];
@@ -29,13 +29,13 @@ declare const integrationItem: z.ZodObject<{
     imageURL: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     id: string;
+    title: string;
     imageURL?: string | undefined;
     description?: string | undefined;
 }, {
-    title: string;
     id: string;
+    title: string;
     imageURL?: string | undefined;
     description?: string | undefined;
 }>;
@@ -46,8 +46,8 @@ interface IntegrationCatalogReadArgs {
 }
 export declare function useIntegrationCatalogRead(args: IntegrationCatalogReadArgs): {
     item: {
-        title: string;
         id: string;
+        title: string;
         imageURL?: string | undefined;
         description?: string | undefined;
     };

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

@@ -6,8 +6,8 @@ export declare function useDocuments(params: {
     localesFilter: Set<FilterOption>;
 }): {
     documents: {
-        title: string;
         id: string;
+        title: string;
         language: {
             id: string;
             name: string;
@@ -66,8 +66,8 @@ export declare function useDocuments(params: {
                 preview_image?: string | undefined;
                 uid?: string | undefined;
             })[];
-            title: string;
             id: string;
+            title: string;
             language: {
                 id: string;
                 name: string;