@prismicio/types-internal 2.0.0-beta.0 → 2.1.0-alpha.0

package/lib/customtypes/diff/SharedSlice.d.ts

@@ -1,10 +1,730 @@
 import type { SharedSlice } from "../widgets/slices";
 import { type DiffChange } from "./Changes";
 import { VariationDiff } from "./Variation";
-export type SliceMetadata = Omit<SharedSlice, "variations">;
-export type SliceDiff = DiffChange<SharedSlice, Partial<SliceMetadata & {
+export declare type SliceMetadata = Omit<SharedSlice, "variations">;
+export declare type SliceDiff = DiffChange<SharedSlice, Partial<SliceMetadata & {
     variations?: Partial<Record<string, VariationDiff>>;
 }>>;
 export declare const SliceComparator: {
-    compare(sliceA?: SharedSlice, sliceB?: SharedSlice): SliceDiff | undefined;
+    compare(sliceA?: ({
+        id: string;
+        type: "SharedSlice";
+        name: string;
+        variations: readonly ({
+            id: string;
+            name: string;
+            description: string;
+            imageUrl: string;
+            docURL: string;
+            version: string;
+        } & {
+            display?: string;
+            primary?: {
+                [x: string]: ({
+                    type: "Boolean";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                        default_value?: boolean;
+                        placeholder_true?: string;
+                        placeholder_false?: string;
+                    };
+                }) | ({
+                    type: "Color";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Date";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                }) | ({
+                    type: "Embed";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                    };
+                }) | ({
+                    type: "GeoPoint";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Image";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        constraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        thumbnails?: readonly ({
+                            name: string;
+                        } & {
+                            width?: number | null;
+                            height?: number | null;
+                        })[];
+                    };
+                }) | ({
+                    type: "IntegrationFields";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        catalog?: string;
+                    };
+                }) | ({
+                    type: "Link";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                        select?: "media" | "document" | "web" | null;
+                        customtypes?: readonly ({
+                            customTypeId: string;
+                        } & {
+                            fields?: readonly ({
+                                fieldId: string;
+                            } & {
+                                customTypes?: readonly {
+                                    customTypeId: string;
+                                    fields: readonly {
+                                        fieldId: string;
+                                    }[];
+                                }[];
+                            })[];
+                        })[];
+                        masks?: readonly string[];
+                        tags?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Number";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "Range";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "StructuredText";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                        single?: string;
+                        multi?: string;
+                        imageConstraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        labels?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Select";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default_value?: string;
+                        options?: readonly string[];
+                    };
+                }) | ({
+                    type: "Separator";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Text";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Timestamp";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                });
+            };
+            items?: {
+                [x: string]: ({
+                    type: "Boolean";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                        default_value?: boolean;
+                        placeholder_true?: string;
+                        placeholder_false?: string;
+                    };
+                }) | ({
+                    type: "Color";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Date";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                }) | ({
+                    type: "Embed";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                    };
+                }) | ({
+                    type: "GeoPoint";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Image";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        constraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        thumbnails?: readonly ({
+                            name: string;
+                        } & {
+                            width?: number | null;
+                            height?: number | null;
+                        })[];
+                    };
+                }) | ({
+                    type: "IntegrationFields";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        catalog?: string;
+                    };
+                }) | ({
+                    type: "Link";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                        select?: "media" | "document" | "web" | null;
+                        customtypes?: readonly ({
+                            customTypeId: string;
+                        } & {
+                            fields?: readonly ({
+                                fieldId: string;
+                            } & {
+                                customTypes?: readonly {
+                                    customTypeId: string;
+                                    fields: readonly {
+                                        fieldId: string;
+                                    }[];
+                                }[];
+                            })[];
+                        })[];
+                        masks?: readonly string[];
+                        tags?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Number";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "Range";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "StructuredText";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                        single?: string;
+                        multi?: string;
+                        imageConstraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        labels?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Select";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default_value?: string;
+                        options?: readonly string[];
+                    };
+                }) | ({
+                    type: "Separator";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Text";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Timestamp";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                });
+            };
+        })[];
+    } & {
+        description?: string;
+    }) | undefined, sliceB?: ({
+        id: string;
+        type: "SharedSlice";
+        name: string;
+        variations: readonly ({
+            id: string;
+            name: string;
+            description: string;
+            imageUrl: string;
+            docURL: string;
+            version: string;
+        } & {
+            display?: string;
+            primary?: {
+                [x: string]: ({
+                    type: "Boolean";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                        default_value?: boolean;
+                        placeholder_true?: string;
+                        placeholder_false?: string;
+                    };
+                }) | ({
+                    type: "Color";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Date";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                }) | ({
+                    type: "Embed";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                    };
+                }) | ({
+                    type: "GeoPoint";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Image";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        constraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        thumbnails?: readonly ({
+                            name: string;
+                        } & {
+                            width?: number | null;
+                            height?: number | null;
+                        })[];
+                    };
+                }) | ({
+                    type: "IntegrationFields";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        catalog?: string;
+                    };
+                }) | ({
+                    type: "Link";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                        select?: "media" | "document" | "web" | null;
+                        customtypes?: readonly ({
+                            customTypeId: string;
+                        } & {
+                            fields?: readonly ({
+                                fieldId: string;
+                            } & {
+                                customTypes?: readonly {
+                                    customTypeId: string;
+                                    fields: readonly {
+                                        fieldId: string;
+                                    }[];
+                                }[];
+                            })[];
+                        })[];
+                        masks?: readonly string[];
+                        tags?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Number";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "Range";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "StructuredText";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                        single?: string;
+                        multi?: string;
+                        imageConstraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        labels?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Select";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default_value?: string;
+                        options?: readonly string[];
+                    };
+                }) | ({
+                    type: "Separator";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Text";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Timestamp";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                });
+            };
+            items?: {
+                [x: string]: ({
+                    type: "Boolean";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                        default_value?: boolean;
+                        placeholder_true?: string;
+                        placeholder_false?: string;
+                    };
+                }) | ({
+                    type: "Color";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Date";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                }) | ({
+                    type: "Embed";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                    };
+                }) | ({
+                    type: "GeoPoint";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Image";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        constraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        thumbnails?: readonly ({
+                            name: string;
+                        } & {
+                            width?: number | null;
+                            height?: number | null;
+                        })[];
+                    };
+                }) | ({
+                    type: "IntegrationFields";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        catalog?: string;
+                    };
+                }) | ({
+                    type: "Link";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                        select?: "media" | "document" | "web" | null;
+                        customtypes?: readonly ({
+                            customTypeId: string;
+                        } & {
+                            fields?: readonly ({
+                                fieldId: string;
+                            } & {
+                                customTypes?: readonly {
+                                    customTypeId: string;
+                                    fields: readonly {
+                                        fieldId: string;
+                                    }[];
+                                }[];
+                            })[];
+                        })[];
+                        masks?: readonly string[];
+                        tags?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Number";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "Range";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        min?: number;
+                        max?: number;
+                        step?: number;
+                    };
+                }) | ({
+                    type: "StructuredText";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        useAsTitle?: boolean;
+                        single?: string;
+                        multi?: string;
+                        imageConstraint?: {
+                            width?: number | null;
+                            height?: number | null;
+                        };
+                        labels?: readonly string[];
+                        allowTargetBlank?: boolean;
+                    };
+                }) | ({
+                    type: "Select";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default_value?: string;
+                        options?: readonly string[];
+                    };
+                }) | ({
+                    type: "Separator";
+                } & {
+                    config?: {
+                        label?: string | null | undefined;
+                    };
+                }) | ({
+                    type: "Text";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        useAsTitle?: boolean;
+                        placeholder?: string;
+                    };
+                }) | ({
+                    type: "Timestamp";
+                } & {
+                    fieldset?: string | null | undefined;
+                    config?: {
+                        label?: string | null | undefined;
+                        placeholder?: string;
+                        default?: string;
+                    };
+                });
+            };
+        })[];
+    } & {
+        description?: string;
+    }) | undefined): SliceDiff | undefined;
 };