@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.11 → 0.4.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/EditorConfig.d.ts +1 -7
- package/dist/core/OnboardingGuide/OnboardingGuide.d.ts +17 -17
- package/dist/core/OnboardingGuide/components/OnboardingCard.d.ts +2 -5
- package/dist/core/OnboardingGuide/components/OnboardingProgressStepper.d.ts +2 -6
- package/dist/core/OnboardingGuide/components/OnboardingProvider.d.ts +20 -0
- package/dist/core/OnboardingGuide/components/OnboardingStepDialog.d.ts +1 -1
- package/dist/core/OnboardingGuide/components/OnboardingTutorial.d.ts +2 -0
- package/dist/core/OnboardingGuide/content.d.ts +3 -6
- package/dist/core/OnboardingGuide/types.d.ts +39 -0
- package/dist/core/service/index.d.ts +0 -1
- package/dist/core/service/repository.d.ts +1 -1
- package/dist/index.cjs.js +34 -37
- package/dist/index.es.js +9667 -9686
- package/package.json +4 -4
- package/dist/core/service/onboarding.d.ts +0 -83
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"dependencies": {
|
|
3
3
|
"@floating-ui/react-dom-interactions": "0.9.3",
|
|
4
|
-
"@prismicio/editor-support": "0.4.
|
|
4
|
+
"@prismicio/editor-support": "0.4.49",
|
|
5
5
|
"@prismicio/richtext": "2.1.1",
|
|
6
6
|
"@prismicio/types-internal": "2.8.0",
|
|
7
7
|
"@tanstack/react-query": "5.55.4",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"zod": "3.21.4"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
|
-
"@prismicio/editor-ui": "^0.4.49
|
|
36
|
+
"@prismicio/editor-ui": "^0.4.49",
|
|
37
37
|
"@testing-library/react": "15.0.7",
|
|
38
38
|
"@types/react": "18.0.18",
|
|
39
39
|
"@types/react-dom": "18.3.0",
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"module": "./dist/index.es.js",
|
|
69
69
|
"name": "@prismicio/editor-fields",
|
|
70
70
|
"peerDependencies": {
|
|
71
|
-
"@prismicio/editor-ui": "^0.4.49
|
|
71
|
+
"@prismicio/editor-ui": "^0.4.49",
|
|
72
72
|
"react": "18",
|
|
73
73
|
"react-dom": "18"
|
|
74
74
|
},
|
|
@@ -85,5 +85,5 @@
|
|
|
85
85
|
"sideEffects": false,
|
|
86
86
|
"stableVersion": "0.0.0",
|
|
87
87
|
"types": "./dist/index.d.ts",
|
|
88
|
-
"version": "0.4.49
|
|
88
|
+
"version": "0.4.49"
|
|
89
89
|
}
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
/// <reference types="react" />
|
|
2
|
-
import { z } from "zod";
|
|
3
|
-
import { type AuthStrategy } from "../../EditorConfig";
|
|
4
|
-
declare const onboardingStepIds: readonly ["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"];
|
|
5
|
-
export declare const onboardingStepIdSchema: z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>;
|
|
6
|
-
export type OnboardingStepId = typeof onboardingStepIds[number];
|
|
7
|
-
export interface OnboardingStep {
|
|
8
|
-
id: OnboardingStepId;
|
|
9
|
-
title: string;
|
|
10
|
-
description: string;
|
|
11
|
-
content?: JSX.Element;
|
|
12
|
-
videoUrl?: string;
|
|
13
|
-
}
|
|
14
|
-
declare const onboardingFrameworks: readonly ["next", "nuxt", "sveltekit", "other"];
|
|
15
|
-
export type OnboardingFramework = typeof onboardingFrameworks[number];
|
|
16
|
-
export declare const onboardingStateSchema: z.ZodObject<{
|
|
17
|
-
completedSteps: z.ZodArray<z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
|
|
18
|
-
isDismissed: z.ZodBoolean;
|
|
19
|
-
context: z.ZodObject<{
|
|
20
|
-
framework: z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>;
|
|
21
|
-
starterId: z.ZodNullable<z.ZodString>;
|
|
22
|
-
}, "strip", z.ZodTypeAny, {
|
|
23
|
-
framework: "next" | "nuxt" | "sveltekit" | "other";
|
|
24
|
-
starterId: string | null;
|
|
25
|
-
}, {
|
|
26
|
-
framework: "next" | "nuxt" | "sveltekit" | "other";
|
|
27
|
-
starterId: string | null;
|
|
28
|
-
}>;
|
|
29
|
-
}, "strip", z.ZodTypeAny, {
|
|
30
|
-
completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
|
|
31
|
-
isDismissed: boolean;
|
|
32
|
-
context: {
|
|
33
|
-
framework: "next" | "nuxt" | "sveltekit" | "other";
|
|
34
|
-
starterId: string | null;
|
|
35
|
-
};
|
|
36
|
-
}, {
|
|
37
|
-
completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
|
|
38
|
-
isDismissed: boolean;
|
|
39
|
-
context: {
|
|
40
|
-
framework: "next" | "nuxt" | "sveltekit" | "other";
|
|
41
|
-
starterId: string | null;
|
|
42
|
-
};
|
|
43
|
-
}>;
|
|
44
|
-
export type OnboardingState = z.infer<typeof onboardingStateSchema>;
|
|
45
|
-
export declare const onboardingToggleStepResultSchema: z.ZodObject<{
|
|
46
|
-
completedSteps: z.ZodArray<z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
|
|
47
|
-
}, "strip", z.ZodTypeAny, {
|
|
48
|
-
completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
|
|
49
|
-
}, {
|
|
50
|
-
completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
|
|
51
|
-
}>;
|
|
52
|
-
export type OnboardingToggleStepResult = z.infer<typeof onboardingToggleStepResultSchema>;
|
|
53
|
-
export declare const onboardingToggleResultSchema: z.ZodObject<{
|
|
54
|
-
isDismissed: z.ZodBoolean;
|
|
55
|
-
}, "strip", z.ZodTypeAny, {
|
|
56
|
-
isDismissed: boolean;
|
|
57
|
-
}, {
|
|
58
|
-
isDismissed: boolean;
|
|
59
|
-
}>;
|
|
60
|
-
export type OnboardingToggleResult = z.infer<typeof onboardingToggleResultSchema>;
|
|
61
|
-
export declare function getOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingState>;
|
|
62
|
-
export declare function toggleOnboardingStep(stepId: OnboardingStepId, baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleStepResult>;
|
|
63
|
-
export declare function toggleOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleResult>;
|
|
64
|
-
export type OnboardingTrackSource = "PageBuilder" | "SliceMachine";
|
|
65
|
-
export type OnboardingTrackEvent = {
|
|
66
|
-
event: "onboarding:step-completed";
|
|
67
|
-
stepId: OnboardingStepId;
|
|
68
|
-
stepTitle: string;
|
|
69
|
-
source: OnboardingTrackSource;
|
|
70
|
-
} | {
|
|
71
|
-
event: "onboarding:step-opened";
|
|
72
|
-
stepId: OnboardingStepId;
|
|
73
|
-
stepTitle: string;
|
|
74
|
-
source: OnboardingTrackSource;
|
|
75
|
-
} | {
|
|
76
|
-
event: "onboarding:completed";
|
|
77
|
-
source: OnboardingTrackSource;
|
|
78
|
-
};
|
|
79
|
-
export interface OnboardingTracking {
|
|
80
|
-
track: (args: OnboardingTrackEvent) => void | Promise<void>;
|
|
81
|
-
source: OnboardingTrackSource;
|
|
82
|
-
}
|
|
83
|
-
export {};
|