@prismicio/editor-fields 0.4.58 → 0.4.59

package/dist/DocumentEditor.d.ts

@@ -7,7 +7,9 @@ interface Props {
     readOnly?: boolean;
     customType: StaticCustomType;
     sectionName: string;
+    documentId: string;
     content: Document;
+    locale: string;
     onContentChange: (content: Document) => void;
 }
 export declare function DocumentEditor(props: Props): JSX.Element | null;

package/dist/EditorConfig.d.ts

@@ -1,12 +1,13 @@
 /// <reference types="react" />
 import { type MediaAssetType } from "@prismicio/editor-ui";
+import type { MetadataType } from "./core/service";
 export type EditorConfig = {
     baseUrl: URL;
     embedApiEndpoint: URL;
     unsplashApiBaseUrl: URL;
     authStrategy: AuthStrategy;
 } & OptionalConfigs;
-type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig & UserService;
+type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig & UserService & AISeoMetadata;
 type UserService = {
     userServiceBaseUrl?: URL;
 };
@@ -48,6 +49,20 @@ type IntegrationFields = {
     integrationFieldsApiBaseUrl: URL;
     repository: string;
 };
+type AISeoMetadata = {
+    aiSeoMetadataEnabled?: never;
+} | {
+    aiSeoMetadataEnabled: boolean;
+    awsBedrockAccessKeyId: string;
+    awsBedrockSecretAccessKey: string;
+    awsBedrockRegion: string;
+    trackMetadataGeneration: (args: {
+        documentId: string;
+        locale: string;
+        suggestion: string;
+        type: MetadataType;
+    }) => void;
+};
 interface LayoutConfig {
     /**
      * Teaches fields about their containing scrolling element.

package/dist/SectionEditor.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { type Document } from "@prismicio/types-internal/lib/content";
-import type { StaticSection } from "@prismicio/types-internal/lib/customtypes";
+import type { StaticCustomType, StaticSection } from "@prismicio/types-internal/lib/customtypes";
 import type { SliceSelection } from "./SliceSelection";
 interface Props {
     id: string;
@@ -9,6 +9,10 @@ interface Props {
     section: StaticSection;
     content: Document;
     onContentChange: (content: Document) => void;
+    documentId: string;
+    documentContent: Document;
+    documentCustomType: StaticCustomType;
+    documentLocale: string;
 }
 export declare function SectionEditor(props: Props): JSX.Element;
 export {};

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

@@ -21,14 +21,14 @@ export declare const mediaAssetType: z.ZodObject<{
         notes: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string | undefined, string[] | undefined>;
         credits: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string | undefined, string[] | undefined>;
     }, "strip", z.ZodTypeAny, {
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         filename?: string | undefined;
     }, {
-        notes?: string[] | undefined;
         credits?: string[] | undefined;
         alt?: string[] | undefined;
+        notes?: string[] | undefined;
         filename?: string[] | undefined;
     }>>;
     tags: z.ZodArray<z.ZodObject<{
@@ -39,74 +39,74 @@ export declare const mediaAssetType: z.ZodObject<{
         last_modified: z.ZodNumber;
         count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     }, "strip", z.ZodTypeAny, {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }, {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
+    id: string;
     url: string;
-    size: number;
     kind: string;
+    size: number;
     last_modified: number;
     filename: string;
-    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
+    notes?: string | undefined;
     uploader_id?: string | undefined;
     extension?: string | undefined;
     search_highlight?: {
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         filename?: string | undefined;
     } | undefined;
 }, {
-    id: string;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }[];
+    id: string;
     url: string;
-    size: number;
     kind: string;
+    size: number;
     last_modified: number;
     filename: string;
-    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
+    notes?: string | undefined;
     uploader_id?: string | undefined;
     extension?: string | undefined;
     search_highlight?: {
-        notes?: string[] | undefined;
         credits?: string[] | undefined;
         alt?: string[] | undefined;
+        notes?: string[] | undefined;
         filename?: string[] | undefined;
     } | undefined;
 }>;
@@ -136,14 +136,14 @@ export declare const mediaSearchResponse: z.ZodObject<{
             notes: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string | undefined, string[] | undefined>;
             credits: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string | undefined, string[] | undefined>;
         }, "strip", z.ZodTypeAny, {
-            notes?: string | undefined;
             credits?: string | undefined;
             alt?: string | undefined;
+            notes?: string | undefined;
             filename?: string | undefined;
         }, {
-            notes?: string[] | undefined;
             credits?: string[] | undefined;
             alt?: string[] | undefined;
+            notes?: string[] | undefined;
             filename?: string[] | undefined;
         }>>;
         tags: z.ZodArray<z.ZodObject<{
@@ -154,105 +154,105 @@ export declare const mediaSearchResponse: z.ZodObject<{
             last_modified: z.ZodNumber;
             count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
         }, "strip", z.ZodTypeAny, {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }, {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
-        id: string;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
         url: string;
-        size: number;
         kind: string;
+        size: number;
         last_modified: number;
         filename: string;
-        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         uploader_id?: string | undefined;
         extension?: string | undefined;
         search_highlight?: {
-            notes?: string | undefined;
             credits?: string | undefined;
             alt?: string | undefined;
+            notes?: string | undefined;
             filename?: string | undefined;
         } | undefined;
     }, {
-        id: string;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
+        id: string;
         url: string;
-        size: number;
         kind: string;
+        size: number;
         last_modified: number;
         filename: string;
-        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         uploader_id?: string | undefined;
         extension?: string | undefined;
         search_highlight?: {
-            notes?: string[] | undefined;
             credits?: string[] | undefined;
             alt?: string[] | undefined;
+            notes?: string[] | undefined;
             filename?: string[] | undefined;
         } | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
-        id: string;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
         url: string;
-        size: number;
         kind: string;
+        size: number;
         last_modified: number;
         filename: string;
-        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         uploader_id?: string | undefined;
         extension?: string | undefined;
         search_highlight?: {
-            notes?: string | undefined;
             credits?: string | undefined;
             alt?: string | undefined;
+            notes?: string | undefined;
             filename?: string | undefined;
         } | undefined;
     }[];
@@ -260,31 +260,31 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, {
     total: number;
     items: {
-        id: string;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
+        id: string;
         url: string;
-        size: number;
         kind: string;
+        size: number;
         last_modified: number;
         filename: string;
-        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         uploader_id?: string | undefined;
         extension?: string | undefined;
         search_highlight?: {
-            notes?: string[] | undefined;
             credits?: string[] | undefined;
             alt?: string[] | undefined;
+            notes?: string[] | undefined;
             filename?: string[] | undefined;
         } | undefined;
     }[];
@@ -308,31 +308,31 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     page: number;
     total: number;
     items: {
-        id: string;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
         url: string;
-        size: number;
         kind: string;
+        size: number;
         last_modified: number;
         filename: string;
-        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         uploader_id?: string | undefined;
         extension?: string | undefined;
         search_highlight?: {
-            notes?: string | undefined;
             credits?: string | undefined;
             alt?: string | undefined;
+            notes?: string | undefined;
             filename?: string | undefined;
         } | undefined;
     }[];
@@ -357,31 +357,31 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
     media: {
-        id: string;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
         url: string;
-        size: number;
         kind: string;
+        size: number;
         last_modified: number;
         filename: string;
-        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         uploader_id?: string | undefined;
         extension?: string | undefined;
         search_highlight?: {
-            notes?: string | undefined;
             credits?: string | undefined;
             alt?: string | undefined;
+            notes?: string | undefined;
             filename?: string | undefined;
         } | undefined;
     }[];
@@ -407,31 +407,31 @@ 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): {
-    id: string;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
+    id: string;
     url: string;
-    size: number;
     kind: string;
+    size: number;
     last_modified: number;
     filename: string;
-    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
+    notes?: string | undefined;
     uploader_id?: string | undefined;
     extension?: string | undefined;
     search_highlight?: {
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         filename?: string | undefined;
     } | undefined;
 }[];

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

@@ -1,8 +1,8 @@
 import { z } from "zod";
 export declare function useTagSearch(): {
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -20,15 +20,15 @@ export declare const tagSchema: z.ZodObject<{
     last_modified: z.ZodNumber;
     count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     name: string;
+    id: string;
     created_at: number;
     last_modified: number;
     count: number;
     uploader_id?: string | undefined;
 }, {
-    id: string;
     name: string;
+    id: string;
     created_at: number;
     last_modified: number;
     uploader_id?: string | undefined;

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

@@ -1,29 +1,29 @@
 export declare function useSelectedMedia(): {
-    id: string;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
+    id: string;
     url: string;
-    size: number;
     kind: string;
+    size: number;
     last_modified: number;
     filename: string;
-    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
+    notes?: string | undefined;
     uploader_id?: string | undefined;
     extension?: string | undefined;
     search_highlight?: {
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
+        notes?: string | undefined;
         filename?: string | undefined;
     } | undefined;
 }[];

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

@@ -1,6 +1,8 @@
 /// <reference types="react" />
+import type { OnboardingTracking } from "../../service";
 interface OnboardingTutorialProps {
     href: string;
+    tracking: OnboardingTracking;
 }
 export declare function OnboardingTutorial(props: OnboardingTutorialProps): JSX.Element;
 export {};

package/dist/core/SeoMetadata/components/MetadataBadge.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { type MetadataType } from "../../service";
+interface MetadataBadgeProps {
+    type: MetadataType;
+    value: string;
+}
+export declare function MetadataBadge(props: MetadataBadgeProps): JSX.Element;
+export {};

package/dist/core/SeoMetadata/components/MetadataPreview.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface MetadataPreviewProps {
+    title: string;
+    description: string;
+}
+export declare function MetadataPreview(props: MetadataPreviewProps): JSX.Element;
+export {};

package/dist/core/SeoMetadata/index.d.ts

@@ -0,0 +1,2 @@
+export { MetadataBadge } from "./components/MetadataBadge";
+export { MetadataPreview } from "./components/MetadataPreview";

package/dist/core/document.d.ts

@@ -1,5 +1,6 @@
 import { type Document as DocumentT, GroupContent } from "@prismicio/types-internal/lib/content";
 import { type StaticCustomType } from "@prismicio/types-internal/lib/customtypes";
+import type { DocumentVersion } from "./service";
 export declare function prepareDocumentForSave(customType: StaticCustomType, document: DocumentT): DocumentT;
 export declare const defaultGroupContentWithOneItem: GroupContent;
 export declare const documentStatus: {
@@ -20,12 +21,7 @@ export declare const documentStatus: {
         readonly color: "grey";
     };
 };
-export declare const searchDocumentStatus: {
-    unclassified: string[];
-    archived: string[];
-    release: string[];
-    published: string[];
-};
+export declare const searchDocumentStatus: Record<DocumentVersion["status"], DocumentVersion["status"][]>;
 interface getDocumentUrlArgs {
     documentId: string;
     status?: string;

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

@@ -0,0 +1,30 @@
+import { Document } from "@prismicio/types-internal/lib/content";
+import type { StaticCustomType } from "@prismicio/types-internal/lib/customtypes";
+export declare const metaTitleProperty = "meta_title";
+export declare const metaDescriptionProperty = "meta_description";
+export type MetadataType = typeof metaTitleProperty | typeof metaDescriptionProperty;
+interface GenerateSEOMetadataArgs {
+    pageTextContent: string;
+    contentLocale: string;
+    config: {
+        accessKeyId: string;
+        secretAccessKey: string;
+        region: string;
+    };
+}
+export declare function generateSEOMetadata(args: GenerateSEOMetadataArgs): Promise<{
+    meta_title: string;
+    meta_description: string;
+}>;
+export declare const metaTitleConfig: {
+    readonly min: 50;
+    readonly max: 60;
+};
+export declare const metaDescriptionConfig: {
+    readonly min: 120;
+    readonly max: 165;
+};
+export declare function getPageTextContent(document: Document, customType: StaticCustomType): string;
+export declare function extractTextFromField(contentField: unknown): string | undefined;
+export declare function isPageContentRelevantForAISeo(pageContent: string): boolean;
+export {};

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

@@ -7,22 +7,22 @@ declare const customTypeResponse: z.ZodObject<{
     repeatable: z.ZodBoolean;
     status: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
+    status: boolean;
     id: string;
     label: string;
     repeatable: boolean;
-    status: boolean;
 }, {
+    status: boolean;
     id: string;
     label: string;
     repeatable: boolean;
-    status: boolean;
 }>;
 export type CustomTypeResponse = z.TypeOf<typeof customTypeResponse>;
 export declare function getRepositoryCustomTypes(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<{
+    status: boolean;
     id: string;
     label: string;
     repeatable: boolean;
-    status: boolean;
 }[]>;
 interface CustomTypesOptionsArgs {
     baseUrl: URL;
@@ -30,35 +30,42 @@ interface CustomTypesOptionsArgs {
     authStrategy: AuthStrategy;
 }
 export declare function getCustomTypesOptions(args: CustomTypesOptionsArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{
+    status: boolean;
     id: string;
     label: string;
     repeatable: boolean;
-    status: boolean;
 }[], Error, {
+    status: boolean;
     id: string;
     label: string;
     repeatable: boolean;
-    status: boolean;
 }[], string[]> & {
     initialData?: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").L<{
+        status: boolean;
         id: string;
         label: string;
         repeatable: boolean;
-        status: boolean;
     }[]> | undefined;
 } & {
     queryKey: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").E<string[], {
+        status: boolean;
         id: string;
         label: string;
         repeatable: boolean;
-        status: boolean;
     }[]>;
 };
 export declare function prefetchCustomTypes(queryClient: QueryClient, args: CustomTypesOptionsArgs): void;
 export declare function fetchCustomTypes(queryClient: QueryClient, args: CustomTypesOptionsArgs): Promise<{
+    status: boolean;
     id: string;
     label: string;
     repeatable: boolean;
-    status: boolean;
 }[]>;
+export declare function useCustomTypes(args: CustomTypesOptionsArgs): import("@tanstack/react-query/build/legacy/types").UseSuspenseQueryResult<{
+    status: boolean;
+    id: string;
+    label: string;
+    repeatable: boolean;
+}[], Error>;
+export declare function invalidateCustomTypes(queryClient: QueryClient, args: CustomTypesOptionsArgs): Promise<void>;
 export {};