@prismicio/editor-fields 0.4.75 → 0.4.76-alpha.tree-view-component.0

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

@@ -1,6 +1,7 @@
 import { type PropsWithChildren } from "react";
 import { z } from "zod";
-import { type RequestRunReturnType, RequestTypes } from "./Request";
+import { type RequestRunReturnType, type RequestType } from "./Request";
+import { type Filter } from "./Request/components/RequestFiltersFieldset";
 declare const APIExplorerRequestProperties: z.ZodObject<{
     repository: z.ZodObject<{
         id: z.ZodString;
@@ -18,53 +19,76 @@ 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>;
+    advanced: z.ZodDefault<z.ZodBoolean>;
     ref: z.ZodOptional<z.ZodString>;
+    filters: z.ZodEffects<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore", ...("at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore")[]]>;
+        args: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>, "many">]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: "at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore";
+        args: (string | number | boolean | Date | (string | number | boolean | Date)[])[];
+    }, {
+        type: "at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore";
+        args: (string | number | boolean | Date | (string | number | boolean | Date)[])[];
+    }>, "many">>, Filter[], {
+        type: "at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore";
+        args: (string | number | boolean | Date | (string | number | boolean | Date)[])[];
+    }[] | undefined>;
 }, "strip", z.ZodTypeAny, {
-    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
-    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
     repository: {
         id: string;
         accessToken?: string | undefined;
     };
+    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
+    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
+    filters: Filter[];
     pagination: {
-        page?: number | undefined;
         pageSize?: number | undefined;
+        page?: number | undefined;
     };
+    advanced: boolean;
     ref?: string | undefined;
     lang?: string | undefined;
 }, {
-    type: "get" | "getByType" | "getByUID" | "getSingle" | "getRepository";
-    options: Partial<Record<"get" | "getByType" | "getByUID" | "getSingle" | "getRepository", Record<string, string> | undefined>>;
     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;
+    filters?: {
+        type: "at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore";
+        args: (string | number | boolean | Date | (string | number | boolean | Date)[])[];
+    }[] | undefined;
     lang?: string | undefined;
+    advanced?: boolean | 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;
+    setRepositoryAccessToken: (token?: string) => void;
+    setRequestType: (type: RequestType) => void;
+    setRequestOptions: <Type extends RequestType>(type: Type, options: APIExplorerRequestProperties["options"][Type]) => void;
     setPagination: (pagination: {
         page?: number;
         pageSize?: number;
     }) => void;
     setLang: (lang?: string) => void;
+    setAdvanced: (advanced: boolean) => void;
     setRef: (ref?: string) => void;
+    setFilters: (filters: APIExplorerRequestProperties["filters"]) => void;
     run: () => Promise<void>;
 };
 type ResponseBase = {
@@ -106,13 +130,13 @@ type APIExplorerContextType = {
 export type APIExplorerEvents = [
     event: "API Explorer Request",
     args: {
-        type: RequestTypes;
+        type: RequestType;
         repositoryID: string;
     }
 ] | [
     event: "API Explorer Request Error",
     args: {
-        type: RequestTypes;
+        type: RequestType;
         repositoryID: string;
         error?: string;
         url?: string;

package/dist/core/APIExplorer/components/Request/components/RequestFiltersFieldset/FilterConfigDialog.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { type FilterType } from "./types";
+interface FilterConfigDialogProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    type: FilterType;
+    editIndex?: number;
+}
+export declare function FilterConfigDialog(props: FilterConfigDialogProps): JSX.Element;
+export {};

package/dist/core/APIExplorer/components/Request/components/RequestFiltersFieldset/FilterConfigPathInput.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+type FilterConfigPathInputProps = {
+    path: string;
+    setPath: (path: string) => void;
+    description: string;
+    allowedPaths: string[];
+};
+export declare function FilterConfigPathInput(props: FilterConfigPathInputProps): JSX.Element;
+export {};

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

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

package/dist/core/APIExplorer/components/Request/components/RequestFiltersFieldset/getFilterSnippet.d.ts

@@ -0,0 +1,2 @@
+import { type Filter } from "./types";
+export declare function getFilterSnippet(filter: Filter): string;

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

@@ -0,0 +1,3 @@
+export { getFilterSnippet } from "./getFilterSnippet";
+export { RequestFiltersFieldset } from "./RequestFiltersFieldset";
+export { type Filter, FilterTypes } from "./types";

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

@@ -0,0 +1,34 @@
+import { filter } from "@prismicio/client";
+import type { IconName } from "editor-ui/src/components/Icon";
+export type FilterType = keyof typeof filter;
+export declare const FilterTypes: ["at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore", ...("at" | "not" | "any" | "in" | "fulltext" | "has" | "missing" | "similar" | "geopointNear" | "numberLessThan" | "numberGreaterThan" | "numberInRange" | "dateAfter" | "dateBefore" | "dateBetween" | "dateDayOfMonth" | "dateDayOfMonthAfter" | "dateDayOfMonthBefore" | "dateDayOfWeek" | "dateDayOfWeekAfter" | "dateDayOfWeekBefore" | "dateMonth" | "dateMonthAfter" | "dateMonthBefore" | "dateYear" | "dateHour" | "dateHourAfter" | "dateHourBefore")[]];
+type OmitDateFromTuple<T> = T extends [infer U, ...infer V] ? [
+    U extends Date ? never : U extends (infer W)[] ? W extends Date ? never : W : U,
+    ...OmitDateFromTuple<V>
+] : T;
+type FilterArgTuples = {
+    [K in FilterType]: OmitDateFromTuple<Parameters<(typeof filter)[K]>>;
+};
+export type Filter = {
+    [K in FilterType]: {
+        type: K;
+        args: FilterArgTuples[K];
+    };
+}[FilterType];
+export declare const filters: {
+    type: FilterType;
+    icon: IconName;
+    args: string[];
+}[];
+export type FilterAnyArg = string | number | boolean | (string | number | boolean)[];
+export declare const filterPaths: {
+    doc: string;
+    docType: string;
+    docTags: string;
+    docFirstPublicationDate: string;
+    docLastPublicationDate: string;
+    docId: string;
+    myDocUid: string;
+    myDocField: string;
+};
+export {};

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

@@ -2,4 +2,4 @@
 /**
  * Display a fieldset managing a request ref setting.
  */
-export declare function RequestRefFieldset(): JSX.Element;
+export declare function RequestRefFieldset(): JSX.Element | null;

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

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

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

@@ -9,7 +9,9 @@ type RequestOptions = {
 export type RequestConfig<TType extends string> = {
     type: TType;
     Fieldset?: () => JSX.Element;
-    getSnippet: (options: RequestOptions) => string;
+    getSnippet: (options: Omit<RequestOptions, "filters"> & {
+        filters?: symbol[];
+    }) => string;
     run: (client: Client, options: RequestOptions) => Promise<RequestRunReturnType>;
 };
 /**

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

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

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

@@ -10,6 +10,6 @@ export declare const Requests: {
     readonly getRepository: import("./createRequest").RequestConfig<"getRepository">;
 };
 export type Requests = typeof Requests;
-export type RequestTypes = keyof Requests;
+export type RequestType = 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/APIExplorer/hooks/useRepositoryCustomTypes.d.ts

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

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

@@ -1,3 +1,4 @@
-type Primitive = number | string | symbol | undefined;
-export declare function getSnippetArgs(...args: (Primitive | Record<string, Primitive>)[]): string;
+type Primitive = number | string | boolean | symbol | undefined;
+type PrimitiveWithArray = Primitive | Primitive[];
+export declare function getSnippetArgs(...args: (PrimitiveWithArray | Record<string, PrimitiveWithArray>)[]): string;
 export {};

package/dist/core/DeferredBarChart.d.ts

@@ -0,0 +1,3 @@
+import { LazyBarChart } from "@prismicio/editor-ui";
+import { type ComponentProps } from "react";
+export declare function DeferredBarChart(props: ComponentProps<typeof LazyBarChart>): JSX.Element;