@prismicio/editor-fields 0.4.72 → 0.4.74

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

@@ -18,40 +18,40 @@ declare const APIExplorerRequestProperties: z.ZodObject<{
         page: z.ZodOptional<z.ZodNumber>;
         pageSize: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
-        page?: number | undefined;
         pageSize?: number | undefined;
-    }, {
         page?: number | undefined;
+    }, {
         pageSize?: number | undefined;
+        page?: number | undefined;
     }>;
     lang: z.ZodOptional<z.ZodString>;
     ref: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
-    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
     repository: {
         id: string;
         accessToken?: string | undefined;
     };
+    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
+    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
     pagination: {
-        page?: number | undefined;
         pageSize?: number | undefined;
+        page?: number | undefined;
     };
-    ref?: string | undefined;
     lang?: string | undefined;
+    ref?: string | undefined;
 }, {
-    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
-    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
     repository: {
         id: string;
         accessToken?: string | undefined;
     };
+    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
+    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
     pagination: {
-        page?: number | undefined;
         pageSize?: number | undefined;
+        page?: number | undefined;
     };
-    ref?: string | undefined;
     lang?: string | undefined;
+    ref?: string | undefined;
 }>;
 export type APIExplorerRequestProperties = z.infer<typeof APIExplorerRequestProperties>;
 type APIExplorerRequestMethods = {
@@ -88,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

@@ -1,5 +1,5 @@
 /// <reference types="react" />
 /**
- * Display a fieldset managing a request document lang setting.
+ * 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/index.d.ts

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

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

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

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

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

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

@@ -21,15 +21,15 @@ 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, {
-        credits?: string | undefined;
-        alt?: string | undefined;
         notes?: string | undefined;
         filename?: string | undefined;
+        alt?: string | undefined;
+        credits?: string | undefined;
     }, {
-        credits?: string[] | undefined;
-        alt?: string[] | undefined;
         notes?: string[] | undefined;
         filename?: string[] | undefined;
+        alt?: string[] | undefined;
+        credits?: string[] | undefined;
     }>>;
     tags: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -41,73 +41,73 @@ export declare const mediaAssetType: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }, {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     id: string;
+    size: number;
     url: string;
     kind: string;
-    size: number;
+    filename: string;
+    last_modified: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    last_modified: number;
-    filename: string;
+    notes?: string | undefined;
+    extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    credits?: string | undefined;
     alt?: string | undefined;
-    notes?: string | undefined;
     uploader_id?: string | undefined;
-    extension?: string | undefined;
+    credits?: string | undefined;
     search_highlight?: {
-        credits?: string | undefined;
-        alt?: string | undefined;
         notes?: string | undefined;
         filename?: string | undefined;
+        alt?: string | undefined;
+        credits?: string | undefined;
     } | undefined;
 }, {
     id: string;
+    size: number;
     url: string;
     kind: string;
-    size: number;
+    filename: string;
+    last_modified: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }[];
-    last_modified: number;
-    filename: string;
+    notes?: string | undefined;
+    extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    credits?: string | undefined;
     alt?: string | undefined;
-    notes?: string | undefined;
     uploader_id?: string | undefined;
-    extension?: string | undefined;
+    credits?: string | undefined;
     search_highlight?: {
-        credits?: string[] | undefined;
-        alt?: string[] | undefined;
         notes?: string[] | undefined;
         filename?: string[] | undefined;
+        alt?: string[] | undefined;
+        credits?: string[] | undefined;
     } | undefined;
 }>;
 export declare const assetApiHeaders: {
@@ -136,15 +136,15 @@ 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, {
-            credits?: string | undefined;
-            alt?: string | undefined;
             notes?: string | undefined;
             filename?: string | undefined;
+            alt?: string | undefined;
+            credits?: string | undefined;
         }, {
-            credits?: string[] | undefined;
-            alt?: string[] | undefined;
             notes?: string[] | undefined;
             filename?: string[] | undefined;
+            alt?: string[] | undefined;
+            credits?: string[] | undefined;
         }>>;
         tags: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
@@ -156,104 +156,104 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }, {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
+        filename: string;
+        last_modified: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        last_modified: number;
-        filename: string;
+        notes?: string | undefined;
+        extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        credits?: string | undefined;
         alt?: string | undefined;
-        notes?: string | undefined;
         uploader_id?: string | undefined;
-        extension?: string | undefined;
+        credits?: string | undefined;
         search_highlight?: {
-            credits?: string | undefined;
-            alt?: string | undefined;
             notes?: string | undefined;
             filename?: string | undefined;
+            alt?: string | undefined;
+            credits?: string | undefined;
         } | undefined;
     }, {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
+        filename: string;
+        last_modified: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        last_modified: number;
-        filename: string;
+        notes?: string | undefined;
+        extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        credits?: string | undefined;
         alt?: string | undefined;
-        notes?: string | undefined;
         uploader_id?: string | undefined;
-        extension?: string | undefined;
+        credits?: string | undefined;
         search_highlight?: {
-            credits?: string[] | undefined;
-            alt?: string[] | undefined;
             notes?: string[] | undefined;
             filename?: string[] | undefined;
+            alt?: string[] | undefined;
+            credits?: string[] | undefined;
         } | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
+        filename: string;
+        last_modified: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        last_modified: number;
-        filename: string;
+        notes?: string | undefined;
+        extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        credits?: string | undefined;
         alt?: string | undefined;
-        notes?: string | undefined;
         uploader_id?: string | undefined;
-        extension?: string | undefined;
+        credits?: string | undefined;
         search_highlight?: {
-            credits?: string | undefined;
-            alt?: string | undefined;
             notes?: string | undefined;
             filename?: string | undefined;
+            alt?: string | undefined;
+            credits?: string | undefined;
         } | undefined;
     }[];
     cursor?: string | undefined;
@@ -261,31 +261,31 @@ export declare const mediaSearchResponse: z.ZodObject<{
     total: number;
     items: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
+        filename: string;
+        last_modified: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        last_modified: number;
-        filename: string;
+        notes?: string | undefined;
+        extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        credits?: string | undefined;
         alt?: string | undefined;
-        notes?: string | undefined;
         uploader_id?: string | undefined;
-        extension?: string | undefined;
+        credits?: string | undefined;
         search_highlight?: {
-            credits?: string[] | undefined;
-            alt?: string[] | undefined;
             notes?: string[] | undefined;
             filename?: string[] | undefined;
+            alt?: string[] | undefined;
+            credits?: string[] | undefined;
         } | undefined;
     }[];
     cursor?: string | undefined;
@@ -309,31 +309,31 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     total: number;
     items: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
+        filename: string;
+        last_modified: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        last_modified: number;
-        filename: string;
+        notes?: string | undefined;
+        extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        credits?: string | undefined;
         alt?: string | undefined;
-        notes?: string | undefined;
         uploader_id?: string | undefined;
-        extension?: string | undefined;
+        credits?: string | undefined;
         search_highlight?: {
-            credits?: string | undefined;
-            alt?: string | undefined;
             notes?: string | undefined;
             filename?: string | undefined;
+            alt?: string | undefined;
+            credits?: string | undefined;
         } | undefined;
     }[];
     cursor?: string | undefined;
@@ -358,31 +358,31 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     resetFilters: () => void;
     media: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
+        filename: string;
+        last_modified: number;
         tags: {
             id: string;
             name: string;
-            created_at: number;
             last_modified: number;
+            created_at: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        last_modified: number;
-        filename: string;
+        notes?: string | undefined;
+        extension?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        credits?: string | undefined;
         alt?: string | undefined;
-        notes?: string | undefined;
         uploader_id?: string | undefined;
-        extension?: string | undefined;
+        credits?: string | undefined;
         search_highlight?: {
-            credits?: string | undefined;
-            alt?: string | undefined;
             notes?: string | undefined;
             filename?: string | undefined;
+            alt?: string | undefined;
+            credits?: string | undefined;
         } | undefined;
     }[];
     mediaTotal: number;
@@ -408,31 +408,31 @@ 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;
     url: string;
     kind: string;
-    size: number;
+    filename: string;
+    last_modified: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    last_modified: number;
-    filename: string;
+    notes?: string | undefined;
+    extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    credits?: string | undefined;
     alt?: string | undefined;
-    notes?: string | undefined;
     uploader_id?: string | undefined;
-    extension?: string | undefined;
+    credits?: string | undefined;
     search_highlight?: {
-        credits?: string | undefined;
-        alt?: string | undefined;
         notes?: string | undefined;
         filename?: string | undefined;
+        alt?: string | undefined;
+        credits?: string | undefined;
     } | undefined;
 }[];
 interface PageMetadata {

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

@@ -3,8 +3,8 @@ export declare function useTagSearch(): {
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
@@ -22,15 +22,15 @@ export declare const tagSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string;
     name: string;
-    created_at: number;
     last_modified: number;
+    created_at: number;
     count: number;
     uploader_id?: string | undefined;
 }, {
     id: string;
     name: string;
-    created_at: number;
     last_modified: number;
+    created_at: number;
     uploader_id?: string | undefined;
     count?: number | undefined;
 }>;

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

@@ -38,31 +38,31 @@ export declare function uploadMedia(params: {
     config: EditorConfig;
 }): Promise<{
     id: string;
+    size: number;
     url: string;
     kind: string;
-    size: number;
+    filename: string;
+    last_modified: number;
     tags: {
         id: string;
         name: string;
-        created_at: number;
         last_modified: number;
+        created_at: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    last_modified: number;
-    filename: string;
+    notes?: string | undefined;
+    extension?: string | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    credits?: string | undefined;
     alt?: string | undefined;
-    notes?: string | undefined;
     uploader_id?: string | undefined;
-    extension?: string | undefined;
+    credits?: string | undefined;
     search_highlight?: {
-        credits?: string | undefined;
-        alt?: string | undefined;
         notes?: string | undefined;
         filename?: string | undefined;
+        alt?: string | undefined;
+        credits?: string | undefined;
     } | undefined;
 }>;
 export {};