@prismicio/editor-fields 0.4.69 → 0.4.71

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

@@ -1,12 +1,74 @@
 import { type PropsWithChildren } from "react";
-import { type RequestRunReturnType, type RequestTypes } from "./Request";
-export type RequestPagination = {
-    page?: number;
-    pageSize?: number;
+import { z } from "zod";
+import { type RequestRunReturnType, RequestTypes } from "./Request";
+declare const APIExplorerRequestProperties: z.ZodObject<{
+    repository: z.ZodObject<{
+        id: z.ZodString;
+        accessToken: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        accessToken?: string | undefined;
+    }, {
+        id: string;
+        accessToken?: string | undefined;
+    }>;
+    type: z.ZodEnum<["get" | "getByType" | "getByUID" | "getSingle" | "getRepository", ...("get" | "getByType" | "getByUID" | "getSingle" | "getRepository")[]]>;
+    options: z.ZodRecord<z.ZodEnum<["get" | "getByType" | "getByUID" | "getSingle" | "getRepository", ...("get" | "getByType" | "getByUID" | "getSingle" | "getRepository")[]]>, z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    pagination: z.ZodObject<{
+        page: z.ZodOptional<z.ZodNumber>;
+        pageSize: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    }, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    }>;
+    lang: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
+    repository: {
+        id: string;
+        accessToken?: string | undefined;
+    };
+    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
+    pagination: {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    };
+    lang?: 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>>;
+    pagination: {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    };
+    lang?: string | undefined;
+}>;
+export type APIExplorerRequestProperties = z.infer<typeof APIExplorerRequestProperties>;
+type APIExplorerRequestMethods = {
+    setRepositoryID: (id: string) => void;
+    setRepositoryAccessToken: (token: string) => void;
+    setRequestType: (type: RequestTypes) => void;
+    setRequestOptions: <Type extends RequestTypes>(type: Type, options: APIExplorerRequestProperties["options"][Type]) => void;
+    setPagination: (pagination: {
+        page?: number;
+        pageSize?: number;
+    }) => void;
+    setLang: (lang?: string) => void;
+    run: () => Promise<void>;
 };
 type ResponseBase = {
     duration: number;
 };
+type ResponseIdle = {
+    status: "idle";
+};
 type ResponsePending = {
     status: "pending";
 };
@@ -21,34 +83,13 @@ export type ResponseError = ResponseBase & {
     url?: string;
     error: Error;
 };
-export type UseAPIExplorerRequestProperties = {
-    repository: {
-        id: string;
-        accessToken: string;
-    };
-    type: RequestTypes;
-    options: {
-        [Type in RequestTypes]?: Record<string, string>;
-    };
-    pagination: RequestPagination;
-    response?: ResponsePending | ResponseSuccess | ResponseError;
-};
-type UseAPIExplorerRequestMethods = {
-    setRepositoryID: (id: string) => void;
-    setRepositoryAccessToken: (token: string) => void;
-    setRequestType: (type: RequestTypes) => void;
-    setRequestOptions: <Type extends RequestTypes>(type: Type, options: UseAPIExplorerRequestProperties["options"][Type]) => void;
-    setPagination: (pagination: {
-        page?: number;
-        pageSize?: number;
-    }) => void;
-    run: () => Promise<void>;
-};
+type APIExplorerResponse = ResponseIdle | ResponsePending | ResponseSuccess | ResponseError;
+export declare const apiExplorerShareableUrlSearchParam = "request";
 type APIExplorerContextType = {
-    request: UseAPIExplorerRequestProperties & UseAPIExplorerRequestMethods;
+    request: APIExplorerRequestProperties & APIExplorerRequestMethods;
+    response: APIExplorerResponse;
 };
 type APIExplorerProviderProps = PropsWithChildren;
 export declare const APIExplorerProvider: (props: APIExplorerProviderProps) => JSX.Element;
 export declare function useAPIExplorer(): APIExplorerContextType;
-export declare function useAPIExplorerRequest(): UseAPIExplorerRequestProperties & UseAPIExplorerRequestMethods;
 export {};

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

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

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

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

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

@@ -1,12 +1,16 @@
 /// <reference types="react" />
 import type { Client } from "@prismicio/client";
-import type { RequestPagination } from "../APIExplorerContext";
 import type { RequestRunReturnType } from "./types";
+type RequestOptions = Record<string, string | number | undefined> & {
+    page?: number;
+    pageSize?: number;
+    lang?: string;
+};
 export type RequestConfig<TType extends string> = {
     type: TType;
     Fieldset?: () => JSX.Element;
-    getSnippet: (options: Record<string, string | number> & RequestPagination) => string;
-    run: (client: Client, options: Record<string, string | number> & RequestPagination) => Promise<RequestRunReturnType>;
+    getSnippet: (options: RequestOptions) => string;
+    run: (client: Client, options: RequestOptions) => Promise<RequestRunReturnType>;
 };
 /**
  * A factory for creating request handlers (fieldset, snippet, runner, erc.) for the API explorer.
@@ -15,3 +19,4 @@ export type RequestConfig<TType extends string> = {
  * @returns A request handler to be referenced in `./types.ts` for the API explorer to use.
  */
 export declare function createRequest<TType extends string>(config: RequestConfig<TType>): RequestConfig<TType>;
+export {};

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

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

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

@@ -11,4 +11,5 @@ export declare const Requests: {
 };
 export type Requests = typeof Requests;
 export type RequestTypes = keyof Requests;
+export declare const RequestTypes: ["get" | "getByType" | "getByUID" | "getSingle" | "getRepository", ...("get" | "getByType" | "getByUID" | "getSingle" | "getRepository")[]];
 export type RequestRunReturnType = PrismicDocument[] | PrismicDocument | Query | Repository;

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,15 +39,15 @@ 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;
@@ -55,12 +55,12 @@ export declare const mediaAssetType: z.ZodObject<{
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     id: string;
+    size: number;
     url: string;
     kind: string;
-    size: number;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -70,25 +70,25 @@ export declare const mediaAssetType: z.ZodObject<{
     filename: string;
     width?: number | undefined;
     height?: number | undefined;
+    notes?: string | 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;
+    size: number;
     url: string;
     kind: string;
-    size: number;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         uploader_id?: string | undefined;
@@ -98,15 +98,15 @@ export declare const mediaAssetType: z.ZodObject<{
     filename: string;
     width?: number | undefined;
     height?: number | undefined;
+    notes?: string | 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,15 +154,15 @@ 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;
@@ -170,12 +170,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -185,25 +185,25 @@ export declare const mediaSearchResponse: z.ZodObject<{
         filename: string;
         width?: number | undefined;
         height?: number | undefined;
+        notes?: string | 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;
+        size: number;
         url: string;
         kind: string;
-        size: number;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
@@ -213,15 +213,15 @@ export declare const mediaSearchResponse: z.ZodObject<{
         filename: string;
         width?: number | undefined;
         height?: number | undefined;
+        notes?: string | 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">;
@@ -229,12 +229,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
     total: number;
     items: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -244,15 +244,15 @@ export declare const mediaSearchResponse: z.ZodObject<{
         filename: string;
         width?: number | undefined;
         height?: number | undefined;
+        notes?: string | 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;
     }[];
@@ -261,12 +261,12 @@ export declare const mediaSearchResponse: z.ZodObject<{
     total: number;
     items: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
@@ -276,15 +276,15 @@ export declare const mediaSearchResponse: z.ZodObject<{
         filename: string;
         width?: number | undefined;
         height?: number | undefined;
+        notes?: string | 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;
     }[];
@@ -309,12 +309,12 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     total: number;
     items: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -324,15 +324,15 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
         filename: string;
         width?: number | undefined;
         height?: number | undefined;
+        notes?: string | 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;
     }[];
@@ -358,12 +358,12 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     resetFilters: () => void;
     media: {
         id: string;
+        size: number;
         url: string;
         kind: string;
-        size: number;
         tags: {
-            id: string;
             name: string;
+            id: string;
             created_at: number;
             last_modified: number;
             count: number;
@@ -373,15 +373,15 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
         filename: string;
         width?: number | undefined;
         height?: number | undefined;
+        notes?: string | 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;
     }[];
@@ -408,12 +408,12 @@ 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;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -423,15 +423,15 @@ export declare function getMedia(allPages: MediaPage[], keyword: string, assetTy
     filename: string;
     width?: number | undefined;
     height?: number | undefined;
+    notes?: string | 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/useMediaLibraryUpload.d.ts

@@ -38,12 +38,12 @@ export declare function uploadMedia(params: {
     config: EditorConfig;
 }): Promise<{
     id: string;
+    size: number;
     url: string;
     kind: string;
-    size: number;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -53,15 +53,15 @@ export declare function uploadMedia(params: {
     filename: string;
     width?: number | undefined;
     height?: number | undefined;
+    notes?: string | 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/useSelectedMedia.d.ts

@@ -1,11 +1,11 @@
 export declare function useSelectedMedia(): {
     id: string;
+    size: number;
     url: string;
     kind: string;
-    size: number;
     tags: {
-        id: string;
         name: string;
+        id: string;
         created_at: number;
         last_modified: number;
         count: number;
@@ -15,15 +15,15 @@ export declare function useSelectedMedia(): {
     filename: string;
     width?: number | undefined;
     height?: number | undefined;
+    notes?: string | 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;
 }[];