@prismicio/editor-fields 0.4.71 → 0.4.73

package/dist/EditorConfig.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { type MediaAssetType } from "@prismicio/editor-ui";
+import type { APIExplorerEvents } from "./core/APIExplorer/components/APIExplorerContext";
 import type { MetadataType } from "./core/service";
 export type EditorConfig = {
     baseUrl: URL;
@@ -95,19 +96,10 @@ interface OnAnalyticsEvent {
         customTypeFormat: "page" | "custom";
     }): void;
     (event: "Unsplash Image Searched" | "Unsplash Image Added"): void;
-    (event: "API Explorer Request", args: {
-        type: string;
-        repositoryID: string;
-    }): void;
-    (event: "API Explorer Request Error", args: {
-        type: string;
-        repositoryID: string;
-        error?: string;
-        url?: string;
-    }): void;
     (event: "Table Limit Reached", args: {
         type: "row" | "column";
     }): void;
+    (...params: APIExplorerEvents): void;
 }
 interface Analytics {
     onAnalyticsEvent?: OnAnalyticsEvent;

package/dist/core/APIExplorer/APIExplorer.d.ts

@@ -1,2 +1,5 @@
 /// <reference types="react" />
-export declare function APIExplorer(): JSX.Element;
+import { type APIExplorerProviderProps } from "./components/APIExplorerContext";
+type APIExplorerProps = Pick<APIExplorerProviderProps, "repository" | "track">;
+export declare function APIExplorer(props: APIExplorerProps): JSX.Element;
+export {};

package/dist/core/APIExplorer/components/APIExplorerContext.d.ts

@@ -25,6 +25,7 @@ declare const APIExplorerRequestProperties: z.ZodObject<{
         page?: number | undefined;
     }>;
     lang: z.ZodOptional<z.ZodString>;
+    ref: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
     repository: {
@@ -36,6 +37,7 @@ declare const APIExplorerRequestProperties: z.ZodObject<{
         pageSize?: number | undefined;
         page?: number | undefined;
     };
+    ref?: string | undefined;
     lang?: string | undefined;
 }, {
     type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
@@ -48,6 +50,7 @@ declare const APIExplorerRequestProperties: z.ZodObject<{
         pageSize?: number | undefined;
         page?: number | undefined;
     };
+    ref?: string | undefined;
     lang?: string | undefined;
 }>;
 export type APIExplorerRequestProperties = z.infer<typeof APIExplorerRequestProperties>;
@@ -61,6 +64,7 @@ type APIExplorerRequestMethods = {
         pageSize?: number;
     }) => void;
     setLang: (lang?: string) => void;
+    setRef: (ref?: string) => void;
     run: () => Promise<void>;
 };
 type ResponseBase = {
@@ -84,12 +88,40 @@ export type ResponseError = ResponseBase & {
     error: Error;
 };
 type APIExplorerResponse = ResponseIdle | ResponsePending | ResponseSuccess | ResponseError;
-export declare const apiExplorerShareableUrlSearchParam = "request";
+type APIExplorerConfig = {
+    /**
+     * Repository information to use the API Explorer with.
+     * When not provided, the API Explorer will allow entering a repository ID.
+     */
+    repository?: {
+        id: string;
+        documentAPIEndpoint: string;
+    };
+};
 type APIExplorerContextType = {
     request: APIExplorerRequestProperties & APIExplorerRequestMethods;
     response: APIExplorerResponse;
+    config: APIExplorerConfig;
 };
-type APIExplorerProviderProps = PropsWithChildren;
+export type APIExplorerEvents = [
+    event: "API Explorer Request",
+    args: {
+        type: RequestTypes;
+        repositoryID: string;
+    }
+] | [
+    event: "API Explorer Request Error",
+    args: {
+        type: RequestTypes;
+        repositoryID: string;
+        error?: string;
+        url?: string;
+    }
+];
+export type APIExplorerProviderProps = {
+    track?: (...params: APIExplorerEvents) => void;
+} & APIExplorerConfig & PropsWithChildren;
 export declare const APIExplorerProvider: (props: APIExplorerProviderProps) => JSX.Element;
 export declare function useAPIExplorer(): APIExplorerContextType;
+export declare const apiExplorerShareableUrlSearchParam = "request";
 export {};

package/dist/core/APIExplorer/components/Request/components/RequestRefFieldset.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+/**
+ * Display a fieldset managing a request ref setting.
+ */
+export declare function RequestRefFieldset(): JSX.Element;

package/dist/core/APIExplorer/components/Request/components/RequestTypeFieldset.d.ts

@@ -1,7 +1,16 @@
 /// <reference types="react" />
+type RequestTypeFieldsetProps = {
+    nonRepeatableOnly?: boolean;
+};
 /**
  * Display a fieldset managing a request document type setting.
  */
-export declare function RequestTypeFieldset(props: {
-    nonRepeatableOnly?: boolean;
-}): JSX.Element;
+export declare function RequestTypeFieldset(props: RequestTypeFieldsetProps): JSX.Element;
+type RequestTypeFieldsetContentProps = {
+    customTypes?: {
+        id: string;
+        label: string;
+    }[];
+};
+export declare function RequestTypeFieldsetContent(props: RequestTypeFieldsetContentProps): JSX.Element;
+export {};

package/dist/core/APIExplorer/components/Request/components/index.d.ts

@@ -1,4 +1,5 @@
 export { RequestFormInput } from "./RequestFormInput";
 export { RequestLangFieldset } from "./RequestLangFieldset";
 export { RequestPaginationFieldset } from "./RequestPaginationFieldset";
+export { RequestRefFieldset } from "./RequestRefFieldset";
 export { RequestTypeFieldset } from "./RequestTypeFieldset";

package/dist/core/APIExplorer/components/Request/createRequest.d.ts

@@ -5,6 +5,7 @@ type RequestOptions = Record<string, string | number | undefined> & {
     page?: number;
     pageSize?: number;
     lang?: string;
+    ref?: string;
 };
 export type RequestConfig<TType extends string> = {
     type: TType;

package/dist/core/APIExplorer/components/Request/index.d.ts

@@ -1 +1,2 @@
+export { RequestFormInput } from "./components";
 export { type RequestRunReturnType, Requests, RequestTypes } from "./types";

package/dist/core/APIExplorer/hooks/useCopy.d.ts

@@ -0,0 +1,4 @@
+export declare function useCopy(): {
+    isCopied: boolean;
+    copy: (text: string) => Promise<void>;
+};

package/dist/core/APIExplorer/hooks/useRepositoryCustomTypes.d.ts

@@ -0,0 +1,6 @@
+export declare function useRepositoryCustomTypes(nonRepeatableOnly?: boolean): {
+    label: string;
+    status: boolean;
+    id: string;
+    repeatable: boolean;
+}[];

package/dist/core/APIExplorer/hooks/useRequestRepository.d.ts

@@ -0,0 +1 @@
+export declare function useRequestRepository(): import("@prismicio/client").Repository | undefined;

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

@@ -39,28 +39,28 @@ export declare const mediaAssetType: z.ZodObject<{
         last_modified: z.ZodNumber;
         count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     }, "strip", z.ZodTypeAny, {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }, {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    id: string;
     size: number;
+    id: string;
     url: string;
     kind: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -68,9 +68,9 @@ export declare const mediaAssetType: z.ZodObject<{
     }[];
     last_modified: number;
     filename: string;
+    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    notes?: string | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
     uploader_id?: string | undefined;
@@ -82,13 +82,13 @@ export declare const mediaAssetType: z.ZodObject<{
         filename?: string | undefined;
     } | undefined;
 }, {
-    id: string;
     size: number;
+    id: string;
     url: string;
     kind: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         uploader_id?: string | undefined;
@@ -96,9 +96,9 @@ export declare const mediaAssetType: z.ZodObject<{
     }[];
     last_modified: number;
     filename: string;
+    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    notes?: string | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
     uploader_id?: string | undefined;
@@ -154,28 +154,28 @@ export declare const mediaSearchResponse: z.ZodObject<{
             last_modified: z.ZodNumber;
             count: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
         }, "strip", z.ZodTypeAny, {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }, {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
-        id: string;
         size: number;
+        id: string;
         url: string;
         kind: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -183,9 +183,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }[];
         last_modified: number;
         filename: string;
+        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
         uploader_id?: string | undefined;
@@ -197,13 +197,13 @@ export declare const mediaSearchResponse: z.ZodObject<{
             filename?: string | undefined;
         } | undefined;
     }, {
-        id: string;
         size: number;
+        id: string;
         url: string;
         kind: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
@@ -211,9 +211,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }[];
         last_modified: number;
         filename: string;
+        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
         uploader_id?: string | undefined;
@@ -228,13 +228,13 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
-        id: string;
         size: number;
+        id: string;
         url: string;
         kind: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -242,9 +242,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }[];
         last_modified: number;
         filename: string;
+        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
         uploader_id?: string | undefined;
@@ -260,13 +260,13 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, {
     total: number;
     items: {
-        id: string;
         size: number;
+        id: string;
         url: string;
         kind: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
@@ -274,9 +274,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }[];
         last_modified: number;
         filename: string;
+        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
         uploader_id?: string | undefined;
@@ -308,13 +308,13 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     page: number;
     total: number;
     items: {
-        id: string;
         size: number;
+        id: string;
         url: string;
         kind: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -322,9 +322,9 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
         }[];
         last_modified: number;
         filename: string;
+        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
         uploader_id?: string | undefined;
@@ -357,13 +357,13 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
     media: {
-        id: string;
         size: number;
+        id: string;
         url: string;
         kind: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -371,9 +371,9 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
         }[];
         last_modified: number;
         filename: string;
+        notes?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        notes?: string | undefined;
         credits?: string | undefined;
         alt?: string | undefined;
         uploader_id?: string | undefined;
@@ -407,13 +407,13 @@ 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;
     size: number;
+    id: string;
     url: string;
     kind: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -421,9 +421,9 @@ export declare function getMedia(allPages: MediaPage[], keyword: string, assetTy
     }[];
     last_modified: number;
     filename: string;
+    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    notes?: string | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
     uploader_id?: string | undefined;

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

@@ -1,8 +1,8 @@
 import { z } from "zod";
 export declare function useTagSearch(): {
     tags: {
-        name: string;
         id: string;
+        name: 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, {
-    name: string;
     id: string;
+    name: string;
     created_at: number;
     last_modified: number;
     count: number;
     uploader_id?: string | undefined;
 }, {
-    name: string;
     id: string;
+    name: string;
     created_at: number;
     last_modified: number;
     uploader_id?: string | undefined;

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

@@ -37,13 +37,13 @@ export declare function uploadMedia(params: {
     file: File;
     config: EditorConfig;
 }): Promise<{
-    id: string;
     size: number;
+    id: string;
     url: string;
     kind: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -51,9 +51,9 @@ export declare function uploadMedia(params: {
     }[];
     last_modified: number;
     filename: string;
+    notes?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    notes?: string | undefined;
     credits?: string | undefined;
     alt?: string | undefined;
     uploader_id?: string | undefined;

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

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

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

@@ -16,20 +16,20 @@ declare const unsplashImage: import("zod").ZodObject<{
     alt_description: import("zod").ZodOptional<import("zod").ZodString>;
     description: import("zod").ZodNullable<import("zod").ZodString>;
 }, "strip", import("zod").ZodTypeAny, {
+    description: string | null;
+    id: string;
     width: number;
     height: number;
-    id: string;
-    description: string | null;
     urls: {
         small: string;
         full: string;
     };
     alt_description?: string | undefined;
 }, {
+    description: string | null;
+    id: string;
     width: number;
     height: number;
-    id: string;
-    description: string | null;
     urls: {
         small: string;
         full: string;
@@ -54,20 +54,20 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
         alt_description: import("zod").ZodOptional<import("zod").ZodString>;
         description: import("zod").ZodNullable<import("zod").ZodString>;
     }, "strip", import("zod").ZodTypeAny, {
+        description: string | null;
+        id: string;
         width: number;
         height: number;
-        id: string;
-        description: string | null;
         urls: {
             small: string;
             full: string;
         };
         alt_description?: string | undefined;
     }, {
+        description: string | null;
+        id: string;
         width: number;
         height: number;
-        id: string;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -76,10 +76,10 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
     }>, "many">;
 }, "strip", import("zod").ZodTypeAny, {
     results: {
+        description: string | null;
+        id: string;
         width: number;
         height: number;
-        id: string;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -88,10 +88,10 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
     }[];
 }, {
     results: {
+        description: string | null;
+        id: string;
         width: number;
         height: number;
-        id: string;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -99,10 +99,10 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
         alt_description?: string | undefined;
     }[];
 }>, {
+    description: string | null;
+    id: string;
     width: number;
     height: number;
-    id: string;
-    description: string | null;
     urls: {
         small: string;
         full: string;
@@ -110,10 +110,10 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
     alt_description?: string | undefined;
 }[], {
     results: {
+        description: string | null;
+        id: string;
         width: number;
         height: number;
-        id: string;
-        description: string | null;
         urls: {
             small: string;
             full: string;
@@ -124,10 +124,10 @@ export declare const unsplashSearchApiType: import("zod").ZodEffects<import("zod
 export type UnplashSearchApi = TypeOf<typeof unsplashSearchApiType>;
 export type UnsplashImage = TypeOf<typeof unsplashImage>;
 export declare function useUnsplashSearch(baseUrl: URL, term: string): {
+    description: string | null;
+    id: string;
     width: number;
     height: number;
-    id: string;
-    description: string | null;
     urls: {
         small: string;
         full: string;

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

@@ -2031,5 +2031,5 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
 } & {
     format?: "custom" | "page" | undefined;
 }, Error>;
-export declare function prefetchStaticCustomType(queryClient: QueryClient, args: CustomTypeOptionsArgs): void;
+export declare function usePrefetchStaticCustomType(args: CustomTypeOptionsArgs): void;
 export {};