@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.9 → 0.4.49-alpha.feat-onboarding-guide.11
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 +4 -3
- package/dist/core/MediaLibrary/hooks/uploadersData.d.ts +11 -16
- package/dist/core/OnboardingGuide/OnboardingGuide.d.ts +4 -4
- package/dist/core/OnboardingGuide/components/OnboardingCard.d.ts +5 -3
- package/dist/core/OnboardingGuide/components/OnboardingProgressStepper.d.ts +5 -3
- package/dist/core/OnboardingGuide/components/OnboardingStepDialog.d.ts +1 -1
- package/dist/core/OnboardingGuide/content.d.ts +1 -1
- package/dist/core/OnboardingGuide/index.d.ts +0 -1
- package/dist/core/service/document.d.ts +528 -256
- package/dist/core/service/onboarding.d.ts +73 -8
- package/dist/core/service/repository.d.ts +6 -0
- package/dist/core/service/user.d.ts +13 -1
- package/dist/fields/LinkField/Documents/documentsData.d.ts +2 -0
- package/dist/fields/LinkField/LinkDescriptionCard.d.ts +14 -0
- package/dist/fields/LinkField/LinkField.d.ts +19 -2
- package/dist/fields/LinkField/LinkFieldActions.d.ts +7 -4
- package/dist/fields/LinkField/LinkImageCard.d.ts +9 -0
- package/dist/fields/LinkField/WebLinks/WebLinkModal.d.ts +11 -0
- package/dist/fields/LinkField/index.d.ts +3 -1
- package/dist/fields/LinkField/useLinkField.d.ts +11 -9
- package/dist/fields/RichTextField/coreExtensions/ListItem.d.ts +8 -12
- package/dist/index.cjs.js +39 -39
- package/dist/index.d.ts +1 -1
- package/dist/index.es.js +17431 -16995
- package/dist/slices/utils.d.ts +46 -23
- package/package.json +2 -2
- package/dist/core/OnboardingGuide/types.d.ts +0 -79
- package/dist/fields/externalLinks.d.ts +0 -2
package/dist/EditorConfig.d.ts
CHANGED
|
@@ -6,7 +6,10 @@ export type EditorConfig = {
|
|
|
6
6
|
unsplashApiBaseUrl: URL;
|
|
7
7
|
authStrategy: AuthStrategy;
|
|
8
8
|
} & OptionalConfigs;
|
|
9
|
-
type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig & RepositoryConfig;
|
|
9
|
+
type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig & RepositoryConfig & UserService;
|
|
10
|
+
type UserService = {
|
|
11
|
+
userServiceBaseUrl?: URL;
|
|
12
|
+
};
|
|
10
13
|
type MediaLibrary = {
|
|
11
14
|
mediaLibrary?: never;
|
|
12
15
|
} | {
|
|
@@ -15,7 +18,6 @@ type MediaLibrary = {
|
|
|
15
18
|
repository: string;
|
|
16
19
|
coreApiBaseUrl: URL;
|
|
17
20
|
userServiceBaseUrl: URL;
|
|
18
|
-
mediaLibraryUploadersEnabled: boolean;
|
|
19
21
|
};
|
|
20
22
|
type UIDField = {
|
|
21
23
|
uidField?: never;
|
|
@@ -36,7 +38,6 @@ type SearchDocuments = {
|
|
|
36
38
|
status: "published" | "release" | "archived" | "unclassified";
|
|
37
39
|
localeId?: string;
|
|
38
40
|
customTypeId?: string;
|
|
39
|
-
documentListOpenSearchEnabled: boolean;
|
|
40
41
|
documentSearchBaseUrl: URL;
|
|
41
42
|
};
|
|
42
43
|
type IntegrationFields = {
|
|
@@ -1,21 +1,15 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
export interface UploaderWithMeta {
|
|
3
|
+
id: string;
|
|
4
|
+
name: string;
|
|
5
|
+
firstName?: string;
|
|
6
|
+
lastName?: string;
|
|
7
|
+
email?: string;
|
|
8
|
+
uploadedAvatar?: string;
|
|
9
|
+
}
|
|
2
10
|
export declare function useUploaders(): {
|
|
3
|
-
uploaders:
|
|
4
|
-
|
|
5
|
-
name: string;
|
|
6
|
-
firstName: string;
|
|
7
|
-
lastName: string;
|
|
8
|
-
email: string;
|
|
9
|
-
uploadedAvatar: string | undefined;
|
|
10
|
-
}[];
|
|
11
|
-
uploadersById: Map<string, {
|
|
12
|
-
id: string;
|
|
13
|
-
name: string;
|
|
14
|
-
firstName: string;
|
|
15
|
-
lastName: string;
|
|
16
|
-
email: string;
|
|
17
|
-
uploadedAvatar: string | undefined;
|
|
18
|
-
}>;
|
|
11
|
+
uploaders: UploaderWithMeta[];
|
|
12
|
+
uploadersById: Map<string, UploaderWithMeta>;
|
|
19
13
|
};
|
|
20
14
|
export declare const uploaderSchema: z.ZodObject<{
|
|
21
15
|
id: z.ZodString;
|
|
@@ -27,4 +21,5 @@ export declare const uploaderSchema: z.ZodObject<{
|
|
|
27
21
|
export type Uploader = z.TypeOf<typeof uploaderSchema>;
|
|
28
22
|
type UpdateUploadersFunction = (currentItems: Uploader[]) => Uploader[] | undefined;
|
|
29
23
|
export declare function updateUploadersCache(updateFunction: UpdateUploadersFunction): void;
|
|
24
|
+
export declare function useRevalidateUploaders(): () => void;
|
|
30
25
|
export {};
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { type ConfettiConfig } from "dom-confetti";
|
|
3
|
-
import type { OnboardingState, OnboardingStepId,
|
|
3
|
+
import type { OnboardingState, OnboardingStepId, OnboardingTracking } from "../service";
|
|
4
4
|
interface OnboardingGuideProps {
|
|
5
|
+
onboardingState: OnboardingState;
|
|
5
6
|
tracking: OnboardingTracking;
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
toggleOnboardingGuide: () => Promise<OnboardingToggleResult>;
|
|
7
|
+
onToggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
|
|
8
|
+
onToggleGuide: () => Promise<void>;
|
|
9
9
|
}
|
|
10
10
|
export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element;
|
|
11
11
|
export declare function useConfetti(confettiConfig: ConfettiConfig): {
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import type {
|
|
2
|
+
import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
|
|
3
3
|
interface OnboardingCardProps {
|
|
4
|
+
steps: OnboardingStep[];
|
|
5
|
+
completedSteps: OnboardingStepId[];
|
|
6
|
+
tutorialLink?: string;
|
|
4
7
|
tracking: OnboardingTracking;
|
|
5
|
-
|
|
6
|
-
toggleOnboardingStep: (stepId: OnboardingStepId) => Promise<OnboardingToggleStepResult>;
|
|
8
|
+
onToggleStep: (step: OnboardingStep) => Promise<void>;
|
|
7
9
|
onClose?: () => void;
|
|
8
10
|
}
|
|
9
11
|
export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import type {
|
|
2
|
+
import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
|
|
3
3
|
interface OnboardingProgressStepperProps {
|
|
4
|
+
steps: OnboardingStep[];
|
|
5
|
+
completedSteps: OnboardingStepId[];
|
|
6
|
+
completedStepsCount: number;
|
|
7
|
+
onToggleStep: (step: OnboardingStep) => Promise<void>;
|
|
4
8
|
tracking: OnboardingTracking;
|
|
5
|
-
fetchOnboarding: () => Promise<OnboardingState>;
|
|
6
|
-
toggleOnboardingStep: (stepId: OnboardingStepId) => Promise<OnboardingToggleStepResult>;
|
|
7
9
|
}
|
|
8
10
|
export declare function OnboardingProgressStepper(props: OnboardingProgressStepperProps): JSX.Element | null;
|
|
9
11
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { OnboardingFramework, OnboardingStep } from "
|
|
1
|
+
import type { OnboardingFramework, OnboardingStep } from "../service/onboarding";
|
|
2
2
|
export declare function getOnboardingContent(framework?: OnboardingFramework, starter?: string): {
|
|
3
3
|
steps: OnboardingStep[];
|
|
4
4
|
defaultCompletedStepIds: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
|