@prismicio/editor-fields 0.4.44 → 0.4.46

package/dist/EditorConfig.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import type { MediaAssetType } from "./core/MediaLibrary/hooks/mediaLibraryData";
+import { type MediaAssetType } from "@prismicio/editor-ui";
 export type EditorConfig = {
     baseUrl: URL;
     embedApiEndpoint: URL;
@@ -13,8 +13,6 @@ type MediaLibrary = {
     mediaLibrary: true;
     assetsApiBaseUrl: URL;
     repository: string;
-    useOpenSearch: boolean;
-    mediaLibraryTagsEnabled: boolean;
 };
 type UIDField = {
     uidField?: never;
@@ -53,7 +51,6 @@ interface LayoutConfig {
 }
 interface OnAnalyticsEvent {
     (event: "Media Library Search", args: {
-        useOpenSearch: "1" | "0";
         assetType: MediaAssetType;
         mode: "browse" | "select";
         searchQuery: string;
@@ -63,7 +60,6 @@ interface OnAnalyticsEvent {
         tags: string;
     }): void;
     (event: "Media Added To Page", args: {
-        useOpenSearch: "1" | "0";
         assetType: MediaAssetType;
         searchQuery: string;
         numberOfWords: string;

package/dist/core/DeferredCodeBlock.d.ts

@@ -0,0 +1,3 @@
+import { LazyCodeBlock } from "@prismicio/editor-ui";
+import { type ComponentProps } from "react";
+export declare function DeferredCodeBlock(props: ComponentProps<typeof LazyCodeBlock>): JSX.Element;

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

@@ -1,8 +1,9 @@
+import { type MediaAssetType } from "@prismicio/editor-ui";
 import { type RefObject } from "react";
-import { type MediaAssetType } from "../MediaLibrary/hooks/mediaLibraryData";
 interface MediaLibraryProps {
     /**
-     * The type of media to fetch from the media library.
+     * The type of media to limit the media library to.
+     * If different than `all`, the media library will disable the asset type filter
      * @default all
      */
     assetType?: MediaAssetType;

package/dist/core/MediaLibrary/components/MediaLibraryContext.d.ts

@@ -1,5 +1,6 @@
+import { type MediaAssetType } from "@prismicio/editor-ui";
 import { type PropsWithChildren, type RefObject } from "react";
-import { type MediaAsset, type MediaAssetType } from "../hooks/mediaLibraryData";
+import { type MediaAsset, type MediaLibraryFilters } from "../hooks/mediaLibraryData";
 import { type UploadFile } from "../hooks/useMediaLibraryUpload";
 interface MediaLibraryContextValue {
     onScrollToBottom: () => void;
@@ -14,7 +15,6 @@ interface MediaLibraryContextValue {
      *  A ref to render the actions container outside the media library.
      */
     actionContainerRef?: RefObject<HTMLDivElement>;
-    assetType?: MediaAssetType;
     onFilesUpload: (files: File[]) => void;
     isUploading: boolean;
     uploadingFiles: UploadFile[];
@@ -22,9 +22,18 @@ interface MediaLibraryContextValue {
     isMediaRevalidationInProgress: boolean;
     revalidateMedia: () => void;
     keyword: string;
-    onKeywordChange: (term: string) => void;
+    /**
+     * The type of assets to search for.
+     * Possible to change using a filter in the media library.
+     */
+    assetType: MediaAssetType;
+    /**
+     * The type of assets this media library is restricted to.
+     * Possible to change using an `assetType` prop in MediaLibrary
+     */
+    initialAssetType: MediaAssetType;
     tagIds: string[];
-    onTagIdsChange: (newTagIds: string[]) => void;
+    onFilterChange: (filters: Partial<MediaLibraryFilters>) => void;
     isSearchingMedia: boolean;
     tagManagerOpen: boolean;
     setTagManagerOpen: (open: boolean) => void;
@@ -34,7 +43,7 @@ interface MediaLibraryContextValue {
 type MediaSection = "tags";
 interface MediaLibraryProviderProps extends PropsWithChildren {
     /**
-     * The type of media to fetch from the media library.
+     * The type of media to allow in the media library.
      * @default all
      */
     assetType?: MediaAssetType;

package/dist/core/MediaLibrary/components/Sidepane/components/SidepaneMetadataTags/MultiMediaMetadataTags.d.ts

@@ -1,9 +1,7 @@
 /// <reference types="react" />
 import { type MediaAsset } from "../../../../hooks/mediaLibraryData";
-import { type Tag } from "../../../../hooks/tagData";
 interface MultiMediaMetadataTagsProps {
     selectedMedia: MediaAsset[];
 }
 export declare function MultiMediaMetadataTags(props: MultiMediaMetadataTagsProps): JSX.Element;
-export declare function getCommonMediaTags(medias: MediaAsset[]): Tag[];
 export {};

package/dist/core/MediaLibrary/components/Sidepane/components/SidepaneMetadataTags/SidepaneMetadataTags.utils.d.ts

@@ -0,0 +1,3 @@
+import type { MediaAsset } from "../../../../hooks/mediaLibraryData";
+import type { Tag } from "../../../../hooks/tagData";
+export declare function getCommonMediaTags(medias: MediaAsset[]): Tag[];

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

@@ -1,3 +1,4 @@
+import { type MediaAssetType } from "@prismicio/editor-ui";
 import { z } from "zod";
 import { type AuthStrategy, type EditorConfig } from "../../../EditorConfig";
 export declare const mediaAssetType: z.ZodObject<{
@@ -52,7 +53,6 @@ export declare const mediaAssetType: z.ZodObject<{
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     tags: {
         id: string;
         name: string;
@@ -61,11 +61,12 @@ export declare const mediaAssetType: z.ZodObject<{
         count: number;
         uploader_id?: string | undefined;
     }[];
+    id: string;
+    url: string;
+    size: number;
     last_modified: number;
     kind: string;
     filename: string;
-    url: string;
-    size: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
@@ -79,7 +80,6 @@ export declare const mediaAssetType: z.ZodObject<{
         credits?: string | undefined;
     } | undefined;
 }, {
-    id: string;
     tags: {
         id: string;
         name: string;
@@ -88,11 +88,12 @@ export declare const mediaAssetType: z.ZodObject<{
         uploader_id?: string | undefined;
         count?: number | undefined;
     }[];
+    id: string;
+    url: string;
+    size: number;
     last_modified: number;
     kind: string;
     filename: string;
-    url: string;
-    size: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
@@ -164,7 +165,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
-        id: string;
         tags: {
             id: string;
             name: string;
@@ -173,11 +173,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
+        url: string;
+        size: number;
         last_modified: number;
         kind: string;
         filename: string;
-        url: string;
-        size: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -191,7 +192,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
             credits?: string | undefined;
         } | undefined;
     }, {
-        id: string;
         tags: {
             id: string;
             name: string;
@@ -200,11 +200,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
+        id: string;
+        url: string;
+        size: number;
         last_modified: number;
         kind: string;
         filename: string;
-        url: string;
-        size: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -221,7 +222,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
-        id: string;
         tags: {
             id: string;
             name: string;
@@ -230,11 +230,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
+        url: string;
+        size: number;
         last_modified: number;
         kind: string;
         filename: string;
-        url: string;
-        size: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -252,7 +253,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, {
     total: number;
     items: {
-        id: string;
         tags: {
             id: string;
             name: string;
@@ -261,11 +261,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
+        id: string;
+        url: string;
+        size: number;
         last_modified: number;
         kind: string;
         filename: string;
-        url: string;
-        size: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -290,13 +291,7 @@ export interface ExternalImage {
     alt?: string;
 }
 export type MediaAssetOrExternalImage = MediaAsset | ExternalImage;
-/**
- * set the allowed media type for the media library
- * @param all for both images and PDFs
- * @param image for only images
- */
-export type MediaAssetType = "all" | "image";
-export declare function searchMedia(baseUrl: URL | undefined, repository: string, authStrategy: AuthStrategy, assetType: MediaAssetType, keyword: string, tags: string, useOpenSearch: boolean, page: number, cursor?: string): Promise<{
+export declare function searchMedia(baseUrl: URL | undefined, repository: string, authStrategy: AuthStrategy, assetType: MediaAssetType, keyword: string, tags: string, page: number, cursor?: string): Promise<{
     time: string;
     assetType: MediaAssetType;
     keyword: string;
@@ -304,7 +299,6 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     tags: string;
     total: number;
     items: {
-        id: string;
         tags: {
             id: string;
             name: string;
@@ -313,11 +307,12 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
+        url: string;
+        size: number;
         last_modified: number;
         kind: string;
         filename: string;
-        url: string;
-        size: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -334,16 +329,22 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     cursor?: string | undefined;
 }>;
 interface UseMediaLibrarySearchArgs {
-    assetType?: MediaAssetType;
+    initialAssetType?: MediaAssetType;
     mode: "select" | "browse";
 }
+export interface MediaLibraryFilters {
+    keyword: string;
+    assetType: MediaAssetType;
+    tagIds: string[];
+}
+export declare const defaultMediaLibraryFilters: MediaLibraryFilters;
 export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     keyword: string;
-    setKeyword: (keyword: string) => void;
+    assetType: MediaAssetType;
     tagIds: string[];
-    setTagIds: (newTagIds: string[]) => void;
+    setFilters: (filters: Partial<MediaLibraryFilters>) => void;
+    resetFilters: () => void;
     media: {
-        id: string;
         tags: {
             id: string;
             name: string;
@@ -352,11 +353,12 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
             count: number;
             uploader_id?: string | undefined;
         }[];
+        id: string;
+        url: string;
+        size: number;
         last_modified: number;
         kind: string;
         filename: string;
-        url: string;
-        size: number;
         extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
@@ -380,19 +382,18 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     deleteSearchData: typeof deleteSearchData;
     revalidateFirstPage: typeof revalidateFirstPage;
 };
+/**
+ * Function to update media items in the cache and ensure
+ * that the shown data is up to date.
+ */
 declare function updateMedia(newFiles: {
     id: string;
     response: Partial<MediaAsset> | undefined;
 }[]): void;
 declare function deleteMedia(mediaIds: string[]): void;
-interface DeleteSearchDataArgs {
-    keyword?: string;
-    tagIds?: string[];
-}
-declare function deleteSearchData(args: DeleteSearchDataArgs): void;
+declare function deleteSearchData(args: MediaLibraryFilters): void;
 type MediaPage = Awaited<ReturnType<typeof searchMedia>>;
 export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetType, keyword: string, tags: string): {
-    id: string;
     tags: {
         id: string;
         name: string;
@@ -401,11 +402,12 @@ export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetTyp
         count: number;
         uploader_id?: string | undefined;
     }[];
+    id: string;
+    url: string;
+    size: number;
     last_modified: number;
     kind: string;
     filename: string;
-    url: string;
-    size: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
@@ -428,8 +430,13 @@ type UpdateMediaFunction = (currentItems: MediaAsset[], metadata: PageMetadata)
 export declare function updateMediaCache(updateFunction: UpdateMediaFunction): void;
 interface RevalidateFirstPageArgs {
     config: EditorConfig;
-    assetType: MediaAssetType;
+    keyword?: string;
+    assetType?: MediaAssetType;
+    tagIds?: string[];
 }
+/**
+ * Revalidates the first page of the media library immediately.
+ */
 declare function revalidateFirstPage(args: RevalidateFirstPageArgs): void;
 /**
  * Function to remove media items from cache and ensure that the shown data
@@ -437,19 +444,18 @@ declare function revalidateFirstPage(args: RevalidateFirstPageArgs): void;
  *
  * Clear all media library cache but the first page.
  *
- * Then the first page will be revalidated to be insync with the server data.
+ * Then the first page will be revalidated to be in sync with the server data.
  * By not removing the first page and then revalidating we can avoid unnecessary
  * loading states while relying on the cached data.
  */
 export declare function clearMediaCacheAndRevalidateFirstPage(args: RevalidateFirstPageArgs): void;
-interface SearchMediaArgs {
+export interface SearchMediaArgs {
     assetsApiBaseUrl: URL | undefined;
     repository: string;
     authStrategy: AuthStrategy;
     assetType: MediaAssetType;
     keyword: string;
     tagIds: string[];
-    useOpenSearch: boolean;
     page: number;
     cursor?: string;
 }

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

@@ -1,4 +1,4 @@
-import { type MediaAssetType } from "./mediaLibraryData";
+import { type MediaAssetType } from "@prismicio/editor-ui";
 interface AnalyticsMediaSearchArgs {
     assetType: MediaAssetType;
     keyword: string;

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

@@ -1,13 +1,17 @@
+import { type MediaAssetType } from "@prismicio/editor-ui";
 import type { EditorConfig } from "../../../EditorConfig";
-import { type MediaAssetType } from "./mediaLibraryData";
+import { type SearchMediaArgs } from "./mediaLibraryData";
 interface UseMediaLibraryCacheInvalidationArgs {
     revalidate: () => void;
     config: EditorConfig;
+    keyword: string;
     assetType: MediaAssetType;
+    tagIds: string[];
 }
 export declare function useMediaLibraryCacheInvalidation(args: UseMediaLibraryCacheInvalidationArgs): {
     isMediaRevalidationInProgress: boolean;
     isMediaCacheInvalid: boolean;
     revalidateMedia: () => void;
+    revalidateWithParams: (args: Partial<SearchMediaArgs>) => void;
 };
 export {};

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

@@ -1,5 +1,4 @@
 export declare function useSelectedMedia(): {
-    id: string;
     tags: {
         id: string;
         name: string;
@@ -8,11 +7,12 @@ export declare function useSelectedMedia(): {
         count: number;
         uploader_id?: string | undefined;
     }[];
+    id: string;
+    url: string;
+    size: number;
     last_modified: number;
     kind: string;
     filename: string;
-    url: string;
-    size: number;
     extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;

package/dist/core/UnsplashLibrary/unsplashData.d.ts

@@ -17,9 +17,9 @@ declare const unsplashImage: import("zod").ZodObject<{
     description: import("zod").ZodNullable<import("zod").ZodString>;
 }, "strip", import("zod").ZodTypeAny, {
     id: string;
+    description: string | null;
     width: number;
     height: number;
-    description: string | null;
     urls: {
         small: string;
         full: string;
@@ -27,9 +27,9 @@ declare const unsplashImage: import("zod").ZodObject<{
     alt_description?: string | undefined;
 }, {
     id: string;
+    description: string | null;
     width: number;
     height: number;
-    description: string | null;
     urls: {
         small: string;
         full: string;
@@ -55,9 +55,9 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
         description: import("zod").ZodNullable<import("zod").ZodString>;
     }, "strip", import("zod").ZodTypeAny, {
         id: string;
+        description: string | null;
         width: number;
         height: number;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -65,9 +65,9 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
         alt_description?: string | undefined;
     }, {
         id: string;
+        description: string | null;
         width: number;
         height: number;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -77,9 +77,9 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
 }, "strip", import("zod").ZodTypeAny, {
     results: {
         id: string;
+        description: string | null;
         width: number;
         height: number;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -89,9 +89,9 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
 }, {
     results: {
         id: string;
+        description: string | null;
         width: number;
         height: number;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -100,9 +100,9 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
     }[];
 }>, {
     id: string;
+    description: string | null;
     width: number;
     height: number;
-    description: string | null;
     urls: {
         small: string;
         full: string;
@@ -111,9 +111,9 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
 }[], {
     results: {
         id: string;
+        description: string | null;
         width: number;
         height: number;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -125,9 +125,9 @@ export type UnplashSearchApi = TypeOf<typeof unsplashSearchApiType>;
 export type UnsplashImage = TypeOf<typeof unsplashImage>;
 export declare function useUnsplashSearch(baseUrl: URL, term: string): {
     id: string;
+    description: string | null;
     width: number;
     height: number;
-    description: string | null;
     urls: {
         small: string;
         full: string;

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;
     label: string;
-    repeatable: boolean;
+    id: string;
     status: boolean;
+    repeatable: boolean;
 }, {
-    id: string;
     label: string;
-    repeatable: boolean;
+    id: string;
     status: boolean;
+    repeatable: boolean;
 }>;
 export type CustomTypeResponse = z.TypeOf<typeof customTypeResponse>;
 export declare function getRepositoryCustomTypes(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<{
-    id: string;
     label: string;
-    repeatable: boolean;
+    id: string;
     status: boolean;
+    repeatable: boolean;
 }[]>;
 export {};