@prismicio/editor-fields 0.4.63 → 0.4.64-alpha.fix-simulator-issue.0

package/dist/EditorConfig.d.ts

@@ -52,9 +52,8 @@ type AISeoMetadata = {
     aiSeoMetadataEnabled?: never;
 } | {
     aiSeoMetadataEnabled: boolean;
-    awsBedrockAccessKeyId: string;
-    awsBedrockSecretAccessKey: string;
-    awsBedrockRegion: string;
+    documentBaseUrl: URL;
+    repository: string;
     trackMetadataGeneration: (args: {
         documentId: string;
         locale: string;
@@ -96,6 +95,16 @@ 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;
 }
 interface Analytics {
     onAnalyticsEvent?: OnAnalyticsEvent;

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

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

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

@@ -0,0 +1,54 @@
+import { type PropsWithChildren } from "react";
+import { type RequestRunReturnType, type RequestTypes } from "./Request";
+export type RequestPagination = {
+    page?: number;
+    pageSize?: number;
+};
+type ResponseBase = {
+    duration: number;
+};
+type ResponsePending = {
+    status: "pending";
+};
+export type ResponseSuccess = ResponseBase & {
+    status: "success";
+    url?: string;
+    ref?: string;
+    data: RequestRunReturnType;
+};
+export type ResponseError = ResponseBase & {
+    status: "error";
+    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 APIExplorerContextType = {
+    request: UseAPIExplorerRequestProperties & UseAPIExplorerRequestMethods;
+};
+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/APIExplorerRequest.d.ts

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

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

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

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

@@ -0,0 +1 @@
+export declare const GetByTypeRequest: import("./createRequest").RequestConfig<"getByType">;

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

@@ -0,0 +1 @@
+export declare const GetByUIDRequest: import("./createRequest").RequestConfig<"getByUID">;

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

@@ -0,0 +1 @@
+export declare const GetRepositoryRequest: import("./createRequest").RequestConfig<"getRepository">;

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

@@ -0,0 +1 @@
+export declare const GetRequest: import("./createRequest").RequestConfig<"get">;

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

@@ -0,0 +1 @@
+export declare const GetSingleRequest: import("./createRequest").RequestConfig<"getSingle">;

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

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { type FormInputProps } from "@prismicio/editor-ui";
+import { type RequestFormInputBaseProps } from "./RequestFormInputBase";
+export declare function RequestFormInput(props: Pick<RequestFormInputBaseProps, "label"> & FormInputProps): JSX.Element;

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export type RequestFormInputBaseProps = {
+    label: string;
+    children: JSX.Element;
+};
+export declare function RequestFormInputBase(props: RequestFormInputBaseProps): JSX.Element;

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

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { type SelectProps } from "@prismicio/editor-ui";
+import { type RequestFormInputBaseProps } from "./RequestFormInputBase";
+export declare function RequestFormSelect(props: Pick<RequestFormInputBaseProps, "label"> & SelectProps<string>): JSX.Element;

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

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

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+/**
+ * Display a fieldset managing a request document type setting.
+ */
+export declare function RequestTypeFieldset(props: {
+    nonRepeatableOnly?: boolean;
+}): JSX.Element;

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

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

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

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import type { Client } from "@prismicio/client";
+import { type FormInputProps } from "@prismicio/editor-ui";
+import { type RequestPagination } from "../APIExplorerContext";
+import type { RequestRunReturnType } from "./types";
+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>;
+};
+/**
+ * A factory for creating request handlers (fieldset, snippet, runner, erc.) for the API explorer.
+ *
+ * @param config - Request configuration.
+ * @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 declare function RequestFormInput(props: FormInputProps): JSX.Element;
+export declare function RequestPaginationFieldset(): JSX.Element;

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

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

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

@@ -0,0 +1,14 @@
+import type { PrismicDocument, Query, Repository } from "@prismicio/client";
+/**
+ * All available requests for the API explorer.
+ */
+export declare const Requests: {
+    readonly get: import("./createRequest").RequestConfig<"get">;
+    readonly getByType: import("./createRequest").RequestConfig<"getByType">;
+    readonly getByUID: import("./createRequest").RequestConfig<"getByUID">;
+    readonly getSingle: import("./createRequest").RequestConfig<"getSingle">;
+    readonly getRepository: import("./createRequest").RequestConfig<"getRepository">;
+};
+export type Requests = typeof Requests;
+export type RequestTypes = keyof Requests;
+export type RequestRunReturnType = PrismicDocument[] | PrismicDocument | Query | Repository;

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

@@ -0,0 +1 @@
+export { APIExplorer } from "./APIExplorer";

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,74 +39,74 @@ 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;
+    kind: string;
+    url: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    kind: string;
-    size: number;
     last_modified: number;
     filename: string;
-    width?: number | undefined;
+    notes?: string | undefined;
     height?: number | undefined;
+    width?: number | 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;
+    kind: string;
+    url: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         uploader_id?: string | undefined;
         count?: number | undefined;
     }[];
-    id: string;
-    url: string;
-    kind: string;
-    size: number;
     last_modified: number;
     filename: string;
-    width?: number | undefined;
+    notes?: string | undefined;
     height?: number | undefined;
+    width?: number | 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,105 +154,105 @@ 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;
+        kind: string;
+        url: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
-        width?: number | undefined;
+        notes?: string | undefined;
         height?: number | undefined;
+        width?: number | 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;
+        kind: string;
+        url: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
-        width?: number | undefined;
+        notes?: string | undefined;
         height?: number | undefined;
+        width?: number | 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">;
 }, "strip", z.ZodTypeAny, {
     total: number;
     items: {
+        id: string;
+        size: number;
+        kind: string;
+        url: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
-        width?: number | undefined;
+        notes?: string | undefined;
         height?: number | undefined;
+        width?: number | 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;
     }[];
@@ -260,31 +260,31 @@ export declare const mediaSearchResponse: z.ZodObject<{
 }, {
     total: number;
     items: {
+        id: string;
+        size: number;
+        kind: string;
+        url: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             uploader_id?: string | undefined;
             count?: number | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
-        width?: number | undefined;
+        notes?: string | undefined;
         height?: number | undefined;
+        width?: number | 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;
     }[];
@@ -308,31 +308,31 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
     page: number;
     total: number;
     items: {
+        id: string;
+        size: number;
+        kind: string;
+        url: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
-        width?: number | undefined;
+        notes?: string | undefined;
         height?: number | undefined;
+        width?: number | 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;
     }[];
@@ -357,31 +357,31 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
     media: {
+        id: string;
+        size: number;
+        kind: string;
+        url: string;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
-        width?: number | undefined;
+        notes?: string | undefined;
         height?: number | undefined;
+        width?: number | 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;
     }[];
@@ -407,31 +407,31 @@ 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;
+    kind: string;
+    url: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    kind: string;
-    size: number;
     last_modified: number;
     filename: string;
-    width?: number | undefined;
+    notes?: string | undefined;
     height?: number | undefined;
+    width?: number | 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: {
-        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,31 +37,31 @@ export declare function uploadMedia(params: {
     file: File;
     config: EditorConfig;
 }): Promise<{
+    id: string;
+    size: number;
+    kind: string;
+    url: string;
     tags: {
-        name: string;
         id: string;
+        name: string;
         created_at: number;
         last_modified: number;
         count: number;
         uploader_id?: string | undefined;
     }[];
-    id: string;
-    url: string;
-    kind: string;
-    size: number;
     last_modified: number;
     filename: string;
-    width?: number | undefined;
+    notes?: string | undefined;
     height?: number | undefined;
+    width?: number | 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;
 }>;