@prismicio/editor-fields 0.4.28 → 0.4.29

package/dist/EditorConfig.d.ts

@@ -52,6 +52,7 @@ interface OnAnalyticsEvent {
         numberOfWords: string;
         numberOfResults: string;
         timeToGetResults: string;
+        tags: string;
     }): void;
     (event: "Media Added To Page", args: {
         useOpenSearch: "1" | "0";
@@ -62,6 +63,7 @@ interface OnAnalyticsEvent {
         searchPosition: string;
         mediaIds: string;
         timeToAddMediaToPage: string;
+        tags: string;
     }): void;
     (event: "Unsplash Image Searched" | "Unsplash Image Added"): void;
 }

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

@@ -6,8 +6,8 @@ interface MediaLibraryContextValue {
     isFetchingMedia: boolean;
     media: MediaAsset[];
     mediaTotal: number;
-    /** Remove a media asset from the media library and the cache. */
-    deleteMedia: (id: string) => void;
+    /** Remove media assets from the media library and the cache. */
+    deleteMedia: (ids: string[]) => void;
     /** Update a media asset in the cache. */
     updateMedia: (id: string, update: Partial<MediaAsset>) => void;
     /**
@@ -27,10 +27,15 @@ interface MediaLibraryContextValue {
     revalidateMedia: () => void;
     keyword: string;
     onKeywordChange: (term: string) => void;
+    tagIds: string[];
+    onTagIdsChange: (newTagIds: string[]) => void;
     isSearchingMedia: boolean;
     tagManagerOpen: boolean;
     setTagManagerOpen: (open: boolean) => void;
+    openMediaSection: MediaSection | undefined;
+    setOpenMediaSection: (section: MediaSection | undefined) => void;
 }
+type MediaSection = "tags";
 interface MediaLibraryProviderProps extends PropsWithChildren {
     /**
      * The type of media to fetch from the media library.

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

@@ -1,2 +1,2 @@
 /// <reference types="react" />
-export declare function Tags(): JSX.Element;
+export declare function Tags(): JSX.Element | null;

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

@@ -29,11 +29,41 @@ export declare const mediaAssetType: z.ZodObject<{
         notes?: string[] | undefined;
         credits?: string[] | undefined;
     }>>;
+    tags: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        uploader_id: z.ZodOptional<z.ZodString>;
+        created_at: z.ZodNumber;
+        last_modified: z.ZodNumber;
+        count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        created_at: number;
+        last_modified: number;
+        count: number;
+        uploader_id?: string | undefined;
+    }, {
+        id: string;
+        name: 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;
+        created_at: number;
+        last_modified: number;
+        count: number;
+        uploader_id?: string | undefined;
+    }[];
+    last_modified: number;
     kind: string;
     filename: string;
-    last_modified: number;
     url: string;
     size: number;
     extension?: string | undefined;
@@ -50,9 +80,17 @@ export declare const mediaAssetType: z.ZodObject<{
     } | undefined;
 }, {
     id: string;
+    tags: {
+        id: string;
+        name: string;
+        created_at: number;
+        last_modified: number;
+        uploader_id?: string | undefined;
+        count?: number | undefined;
+    }[];
+    last_modified: number;
     kind: string;
     filename: string;
-    last_modified: number;
     url: string;
     size: number;
     extension?: string | undefined;
@@ -103,11 +141,41 @@ export declare const mediaSearchResponse: z.ZodObject<{
             notes?: string[] | undefined;
             credits?: string[] | undefined;
         }>>;
+        tags: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            uploader_id: z.ZodOptional<z.ZodString>;
+            created_at: z.ZodNumber;
+            last_modified: z.ZodNumber;
+            count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            name: string;
+            created_at: number;
+            last_modified: number;
+            count: number;
+            uploader_id?: string | undefined;
+        }, {
+            id: string;
+            name: 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;
+            created_at: number;
+            last_modified: number;
+            count: number;
+            uploader_id?: string | undefined;
+        }[];
+        last_modified: number;
         kind: string;
         filename: string;
-        last_modified: number;
         url: string;
         size: number;
         extension?: string | undefined;
@@ -124,9 +192,17 @@ export declare const mediaSearchResponse: z.ZodObject<{
         } | undefined;
     }, {
         id: string;
+        tags: {
+            id: string;
+            name: string;
+            created_at: number;
+            last_modified: number;
+            uploader_id?: string | undefined;
+            count?: number | undefined;
+        }[];
+        last_modified: number;
         kind: string;
         filename: string;
-        last_modified: number;
         url: string;
         size: number;
         extension?: string | undefined;
@@ -146,9 +222,17 @@ export declare const mediaSearchResponse: z.ZodObject<{
     total: number;
     items: {
         id: string;
+        tags: {
+            id: string;
+            name: string;
+            created_at: number;
+            last_modified: number;
+            count: number;
+            uploader_id?: string | undefined;
+        }[];
+        last_modified: number;
         kind: string;
         filename: string;
-        last_modified: number;
         url: string;
         size: number;
         extension?: string | undefined;
@@ -169,9 +253,17 @@ export declare const mediaSearchResponse: z.ZodObject<{
     total: number;
     items: {
         id: string;
+        tags: {
+            id: string;
+            name: string;
+            created_at: number;
+            last_modified: number;
+            uploader_id?: string | undefined;
+            count?: number | undefined;
+        }[];
+        last_modified: number;
         kind: string;
         filename: string;
-        last_modified: number;
         url: string;
         size: number;
         extension?: string | undefined;
@@ -204,17 +296,26 @@ export type MediaAssetOrExternalImage = MediaAsset | ExternalImage;
  * @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, useOpenSearch: boolean, page: number, cursor?: string): Promise<{
+export declare function searchMedia(baseUrl: URL | undefined, repository: string, authStrategy: AuthStrategy, assetType: MediaAssetType, keyword: string, tags: string, useOpenSearch: boolean, page: number, cursor?: string): Promise<{
     time: string;
     assetType: MediaAssetType;
     keyword: string;
     page: number;
+    tags: string;
     total: number;
     items: {
         id: string;
+        tags: {
+            id: string;
+            name: string;
+            created_at: number;
+            last_modified: number;
+            count: number;
+            uploader_id?: string | undefined;
+        }[];
+        last_modified: number;
         kind: string;
         filename: string;
-        last_modified: number;
         url: string;
         size: number;
         extension?: string | undefined;
@@ -239,11 +340,21 @@ interface UseMediaLibrarySearchArgs {
 export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     keyword: string;
     setKeyword: (keyword: string) => void;
+    tagIds: string[];
+    setTagIds: (newTagIds: string[]) => void;
     media: {
         id: string;
+        tags: {
+            id: string;
+            name: string;
+            created_at: number;
+            last_modified: number;
+            count: number;
+            uploader_id?: string | undefined;
+        }[];
+        last_modified: number;
         kind: string;
         filename: string;
-        last_modified: number;
         url: string;
         size: number;
         extension?: string | undefined;
@@ -273,14 +384,26 @@ declare function updateMedia(newFiles: {
     id: string;
     response: Partial<MediaAsset> | undefined;
 }[]): void;
-declare function deleteMedia(mediaId: string): void;
-declare function deleteSearchData(keyword: string): void;
+declare function deleteMedia(mediaIds: string[]): void;
+interface DeleteSearchDataArgs {
+    keyword?: string;
+    tagIds?: string[];
+}
+declare function deleteSearchData(args: DeleteSearchDataArgs): void;
 type MediaPage = Awaited<ReturnType<typeof searchMedia>>;
-export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetType, keyword: string): {
+export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetType, keyword: string, tags: string): {
     id: string;
+    tags: {
+        id: string;
+        name: string;
+        created_at: number;
+        last_modified: number;
+        count: number;
+        uploader_id?: string | undefined;
+    }[];
+    last_modified: number;
     kind: string;
     filename: string;
-    last_modified: number;
     url: string;
     size: number;
     extension?: string | undefined;
@@ -296,6 +419,13 @@ export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetTyp
         credits?: string | undefined;
     } | undefined;
 }[];
+interface PageMetadata {
+    page: number;
+    assetType: MediaAssetType;
+    keyword: string;
+}
+type UpdateMediaFunction = (currentItems: MediaAsset[], metadata: PageMetadata) => MediaAsset[] | undefined;
+export declare function updateMediaCache(updateFunction: UpdateMediaFunction): void;
 interface RevalidateFirstPageArgs {
     config: EditorConfig;
     assetType: MediaAssetType;
@@ -318,6 +448,7 @@ interface SearchMediaArgs {
     authStrategy: AuthStrategy;
     assetType: MediaAssetType;
     keyword: string;
+    tagIds: string[];
     useOpenSearch: boolean;
     page: number;
     cursor?: string;

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

@@ -1,14 +1,17 @@
 import { z } from "zod";
 export declare function useTagSearch(): {
-    items: {
+    tags: {
         id: string;
         name: string;
+        created_at: number;
         last_modified: number;
         count: number;
-        created_at: number;
         uploader_id?: string | undefined;
     }[];
 };
+export declare const minTagNameLength = 3;
+export declare const maxTagNameLength = 20;
+export declare const tagNameSchema: z.ZodString;
 export declare const tagSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -19,15 +22,15 @@ export declare const tagSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string;
     name: string;
+    created_at: number;
     last_modified: number;
     count: number;
-    created_at: number;
     uploader_id?: string | undefined;
 }, {
     id: string;
     name: string;
-    last_modified: number;
     created_at: number;
+    last_modified: number;
     uploader_id?: string | undefined;
     count?: number | undefined;
 }>;

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

@@ -2,6 +2,7 @@ import { type MediaAssetType } from "./mediaLibraryData";
 interface AnalyticsMediaSearchArgs {
     assetType: MediaAssetType;
     keyword: string;
+    tagIds: string[];
     mode: "select" | "browse";
 }
 export declare function useMediaLibraryAnalyticsMediaSearch(args: AnalyticsMediaSearchArgs): void;

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

@@ -1,8 +1,16 @@
 export declare function useSelectedMedia(): {
     id: string;
+    tags: {
+        id: string;
+        name: string;
+        created_at: number;
+        last_modified: number;
+        count: number;
+        uploader_id?: string | undefined;
+    }[];
+    last_modified: number;
     kind: string;
     filename: string;
-    last_modified: number;
     url: string;
     size: number;
     extension?: string | undefined;