npm - @prismicio/types-internal - Versions diffs - 2.0.0-beta.0 → 2.1.0-alpha.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (166) hide show

package/lib/content/fields/slices/SlicesContent.d.ts CHANGED Viewed

@@ -1631,7 +1631,7 @@ export declare const isSlicesContent: (u: unknown) => u is {
         };
     }[];
 };
-type SlicesLegacy = Array<unknown>;
+declare type SlicesLegacy = Array<unknown>;
 export declare const SlicesLegacy: (ctx: LegacyContentCtx) => t.Type<{
     __TYPE__: "SliceContentType";
     value: {
@@ -3489,8 +3489,6 @@ export declare const SlicesContent: t.TypeC<{
                                 title?: string;
                             } | null | undefined;
                         }), ({
-                            __TYPE__: "ImageLink";
-                        } & {
                             id: string;
                             url: string;
                             height: string;
@@ -3508,17 +3506,9 @@ export declare const SlicesContent: t.TypeC<{
                             size: string;
                         } & {
                             date?: string | null | undefined;
-                        } & {
-                            __TYPE__: "FileLink";
-                        } & {
-                            size?: string;
-                        }) | ({
-                            __TYPE__: "DocumentLink";
-                        } & {
+                        }) | {
                             id: string;
-                        }) | ({
-                            __TYPE__: "ExternalLink";
-                        } & {
+                        } | ({
                             url: string;
                         } & {
                             kind?: "web";
@@ -3802,8 +3792,6 @@ export declare const SlicesContent: t.TypeC<{
                                     title?: string;
                                 } | null | undefined;
                             }), ({
-                                __TYPE__: "ImageLink";
-                            } & {
                                 id: string;
                                 url: string;
                                 height: string;
@@ -3821,17 +3809,9 @@ export declare const SlicesContent: t.TypeC<{
                                 size: string;
                             } & {
                                 date?: string | null | undefined;
-                            } & {
-                                __TYPE__: "FileLink";
-                            } & {
-                                size?: string;
-                            }) | ({
-                                __TYPE__: "DocumentLink";
-                            } & {
+                            }) | {
                                 id: string;
-                            }) | ({
-                                __TYPE__: "ExternalLink";
-                            } & {
+                            } | ({
                                 url: string;
                             } & {
                                 kind?: "web";
@@ -4117,8 +4097,6 @@ export declare const SlicesContent: t.TypeC<{
                                 title?: string;
                             } | null | undefined;
                         }), ({
-                            __TYPE__: "ImageLink";
-                        } & {
                             id: string;
                             url: string;
                             height: string;
@@ -4136,17 +4114,9 @@ export declare const SlicesContent: t.TypeC<{
                             size: string;
                         } & {
                             date?: string | null | undefined;
-                        } & {
-                            __TYPE__: "FileLink";
-                        } & {
-                            size?: string;
-                        }) | ({
-                            __TYPE__: "DocumentLink";
-                        } & {
+                        }) | {
                             id: string;
-                        }) | ({
-                            __TYPE__: "ExternalLink";
-                        } & {
+                        } | ({
                             url: string;
                         } & {
                             kind?: "web";
@@ -4430,8 +4400,6 @@ export declare const SlicesContent: t.TypeC<{
                                     title?: string;
                                 } | null | undefined;
                             }), ({
-                                __TYPE__: "ImageLink";
-                            } & {
                                 id: string;
                                 url: string;
                                 height: string;
@@ -4449,17 +4417,9 @@ export declare const SlicesContent: t.TypeC<{
                                 size: string;
                             } & {
                                 date?: string | null | undefined;
-                            } & {
-                                __TYPE__: "FileLink";
-                            } & {
-                                size?: string;
-                            }) | ({
-                                __TYPE__: "DocumentLink";
-                            } & {
+                            }) | {
                                 id: string;
-                            }) | ({
-                                __TYPE__: "ExternalLink";
-                            } & {
+                            } | ({
                                 url: string;
                             } & {
                                 kind?: "web";
@@ -4742,8 +4702,6 @@ export declare const SlicesContent: t.TypeC<{
                             title?: string;
                         } | null | undefined;
                     }), ({
-                        __TYPE__: "ImageLink";
-                    } & {
                         id: string;
                         url: string;
                         height: string;
@@ -4761,17 +4719,9 @@ export declare const SlicesContent: t.TypeC<{
                         size: string;
                     } & {
                         date?: string | null | undefined;
-                    } & {
-                        __TYPE__: "FileLink";
-                    } & {
-                        size?: string;
-                    }) | ({
-                        __TYPE__: "DocumentLink";
-                    } & {
+                    }) | {
                         id: string;
-                    }) | ({
-                        __TYPE__: "ExternalLink";
-                    } & {
+                    } | ({
                         url: string;
                     } & {
                         kind?: "web";
@@ -5056,8 +5006,6 @@ export declare const SlicesContent: t.TypeC<{
                                     title?: string;
                                 } | null | undefined;
                             }), ({
-                                __TYPE__: "ImageLink";
-                            } & {
                                 id: string;
                                 url: string;
                                 height: string;
@@ -5075,17 +5023,9 @@ export declare const SlicesContent: t.TypeC<{
                                 size: string;
                             } & {
                                 date?: string | null | undefined;
-                            } & {
-                                __TYPE__: "FileLink";
-                            } & {
-                                size?: string;
-                            }) | ({
-                                __TYPE__: "DocumentLink";
-                            } & {
+                            }) | {
                                 id: string;
-                            }) | ({
-                                __TYPE__: "ExternalLink";
-                            } & {
+                            } | ({
                                 url: string;
                             } & {
                                 kind?: "web";
@@ -5152,5 +5092,5 @@ export declare const SlicesContent: t.TypeC<{
         }>>]>]>;
     }>>;
 }>;
-export type SlicesContent = t.TypeOf<typeof SlicesContent>;
+export declare type SlicesContent = t.TypeOf<typeof SlicesContent>;
 export {};

package/lib/content/fields/slices/SlicesContent.js CHANGED Viewed

@@ -4,7 +4,7 @@ exports.SlicesContent = exports.SlicesLegacy = exports.isSlicesContent = exports
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const function_1 = require("fp-ts/lib/function");
-const t = tslib_1.__importStar(require("io-ts"));
+const t = (0, tslib_1.__importStar)(require("io-ts"));
 const utils_1 = require("../../utils");
 const SliceItem_1 = require("./SliceItem");
 exports.SlicesContentType = "SliceContentType";

package/lib/content/fields/slices/index.js CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./Slice"), exports);
-tslib_1.__exportStar(require("./SliceItem"), exports);
-tslib_1.__exportStar(require("./SlicesContent"), exports);
+(0, tslib_1.__exportStar)(require("./Slice"), exports);
+(0, tslib_1.__exportStar)(require("./SliceItem"), exports);
+(0, tslib_1.__exportStar)(require("./SlicesContent"), exports);

package/lib/content/index.js CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./Document"), exports);
-tslib_1.__exportStar(require("./fields"), exports);
-tslib_1.__exportStar(require("./LegacyContentCtx"), exports);
+(0, tslib_1.__exportStar)(require("./Document"), exports);
+(0, tslib_1.__exportStar)(require("./fields"), exports);
+(0, tslib_1.__exportStar)(require("./LegacyContentCtx"), exports);

package/lib/content/utils.d.ts CHANGED Viewed

@@ -1,9 +1,9 @@
 import { FieldType } from "./fields";
-type WithFieldType = WithContentType & {
+declare type WithFieldType = WithContentType & {
     type: FieldType;
 };
 export declare function hasFieldContentType(obj: unknown): obj is WithFieldType;
-type WithContentType = {
+declare type WithContentType = {
     __TYPE__: string;
 };
 export declare function hasContentType(obj: unknown): obj is WithContentType;

package/lib/content/utils.js CHANGED Viewed

@@ -4,9 +4,10 @@ exports.hasContentType = exports.hasFieldContentType = void 0;
 const Either_1 = require("fp-ts/lib/Either");
 const fields_1 = require("./fields");
 function hasFieldContentType(obj) {
+    var _a;
     return (hasContentType(obj) &&
         obj.__TYPE__ === fields_1.FieldContentType &&
-        (obj === null || obj === void 0 ? void 0 : obj.type) !== undefined &&
+        ((_a = obj) === null || _a === void 0 ? void 0 : _a.type) !== undefined &&
         typeof obj.type === "string" &&
         (0, Either_1.isRight)(fields_1.FieldType.decode(obj.type)));
 }

package/lib/customtypes/CustomType.d.ts CHANGED Viewed

@@ -2,6 +2,10 @@ import { Either } from "fp-ts/lib/Either";
 import * as t from "io-ts";
 import type { SharedSlice } from "./widgets/slices/SharedSlice";
 import type { DynamicWidget } from "./widgets/Widget";
+export declare const CustomTypeFormat: {
+    page: string;
+    custom: string;
+};
 declare class CustomTypeSlicesError extends Error {
     slices: Array<string>;
     message: string;
@@ -91,7 +95,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                 useAsTitle?: boolean;
                 placeholder?: string;
                 select?: "media" | "document" | "web" | null;
-                customtypes?: readonly string[];
+                customtypes?: readonly ({
+                    customTypeId: string;
+                } & {
+                    fields?: readonly ({
+                        fieldId: string;
+                    } & {
+                        customTypes?: readonly {
+                            customTypeId: string;
+                            fields: readonly {
+                                fieldId: string;
+                            }[];
+                        }[];
+                    })[];
+                })[];
                 masks?: readonly string[];
                 tags?: readonly string[];
                 allowTargetBlank?: boolean;
@@ -257,7 +274,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                             useAsTitle?: boolean;
                             placeholder?: string;
                             select?: "media" | "document" | "web" | null;
-                            customtypes?: readonly string[];
+                            customtypes?: readonly ({
+                                customTypeId: string;
+                            } & {
+                                fields?: readonly ({
+                                    fieldId: string;
+                                } & {
+                                    customTypes?: readonly {
+                                        customTypeId: string;
+                                        fields: readonly {
+                                            fieldId: string;
+                                        }[];
+                                    }[];
+                                })[];
+                            })[];
                             masks?: readonly string[];
                             tags?: readonly string[];
                             allowTargetBlank?: boolean;
@@ -430,7 +460,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                             useAsTitle?: boolean;
                             placeholder?: string;
                             select?: "media" | "document" | "web" | null;
-                            customtypes?: readonly string[];
+                            customtypes?: readonly ({
+                                customTypeId: string;
+                            } & {
+                                fields?: readonly ({
+                                    fieldId: string;
+                                } & {
+                                    customTypes?: readonly {
+                                        customTypeId: string;
+                                        fields: readonly {
+                                            fieldId: string;
+                                        }[];
+                                    }[];
+                                })[];
+                            })[];
                             masks?: readonly string[];
                             tags?: readonly string[];
                             allowTargetBlank?: boolean;
@@ -596,7 +639,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                         useAsTitle?: boolean;
                                         placeholder?: string;
                                         select?: "media" | "document" | "web" | null;
-                                        customtypes?: readonly string[];
+                                        customtypes?: readonly ({
+                                            customTypeId: string;
+                                        } & {
+                                            fields?: readonly ({
+                                                fieldId: string;
+                                            } & {
+                                                customTypes?: readonly {
+                                                    customTypeId: string;
+                                                    fields: readonly {
+                                                        fieldId: string;
+                                                    }[];
+                                                }[];
+                                            })[];
+                                        })[];
                                         masks?: readonly string[];
                                         tags?: readonly string[];
                                         allowTargetBlank?: boolean;
@@ -763,7 +819,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                     useAsTitle?: boolean;
                                     placeholder?: string;
                                     select?: "media" | "document" | "web" | null;
-                                    customtypes?: readonly string[];
+                                    customtypes?: readonly ({
+                                        customTypeId: string;
+                                    } & {
+                                        fields?: readonly ({
+                                            fieldId: string;
+                                        } & {
+                                            customTypes?: readonly {
+                                                customTypeId: string;
+                                                fields: readonly {
+                                                    fieldId: string;
+                                                }[];
+                                            }[];
+                                        })[];
+                                    })[];
                                     masks?: readonly string[];
                                     tags?: readonly string[];
                                     allowTargetBlank?: boolean;
@@ -922,7 +991,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                     useAsTitle?: boolean;
                                     placeholder?: string;
                                     select?: "media" | "document" | "web" | null;
-                                    customtypes?: readonly string[];
+                                    customtypes?: readonly ({
+                                        customTypeId: string;
+                                    } & {
+                                        fields?: readonly ({
+                                            fieldId: string;
+                                        } & {
+                                            customTypes?: readonly {
+                                                customTypeId: string;
+                                                fields: readonly {
+                                                    fieldId: string;
+                                                }[];
+                                            }[];
+                                        })[];
+                                    })[];
                                     masks?: readonly string[];
                                     tags?: readonly string[];
                                     allowTargetBlank?: boolean;
@@ -1097,7 +1179,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                         useAsTitle?: boolean;
                                         placeholder?: string;
                                         select?: "media" | "document" | "web" | null;
-                                        customtypes?: readonly string[];
+                                        customtypes?: readonly ({
+                                            customTypeId: string;
+                                        } & {
+                                            fields?: readonly ({
+                                                fieldId: string;
+                                            } & {
+                                                customTypes?: readonly {
+                                                    customTypeId: string;
+                                                    fields: readonly {
+                                                        fieldId: string;
+                                                    }[];
+                                                }[];
+                                            })[];
+                                        })[];
                                         masks?: readonly string[];
                                         tags?: readonly string[];
                                         allowTargetBlank?: boolean;
@@ -1256,7 +1351,20 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                         useAsTitle?: boolean;
                                         placeholder?: string;
                                         select?: "media" | "document" | "web" | null;
-                                        customtypes?: readonly string[];
+                                        customtypes?: readonly ({
+                                            customTypeId: string;
+                                        } & {
+                                            fields?: readonly ({
+                                                fieldId: string;
+                                            } & {
+                                                customTypes?: readonly {
+                                                    customTypeId: string;
+                                                    fields: readonly {
+                                                        fieldId: string;
+                                                    }[];
+                                                }[];
+                                            })[];
+                                        })[];
                                         masks?: readonly string[];
                                         tags?: readonly string[];
                                         allowTargetBlank?: boolean;
@@ -1356,8 +1464,12 @@ export declare const StaticCustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
     status: t.BooleanC;
 }>, t.PartialC<{
     hash: t.StringC;
+    format: t.KeyofC<{
+        page: string;
+        custom: string;
+    }>;
 }>]>>;
-export type StaticCustomType = t.TypeOf<typeof StaticCustomType>;
+export declare type StaticCustomType = t.TypeOf<typeof StaticCustomType>;
 export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
     id: t.StringC;
     label: t.UnionC<[t.Type<string, string, unknown>, t.NullC, t.UndefinedC]>;
@@ -1441,7 +1553,20 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                 useAsTitle?: boolean;
                 placeholder?: string;
                 select?: "media" | "document" | "web" | null;
-                customtypes?: readonly string[];
+                customtypes?: readonly ({
+                    customTypeId: string;
+                } & {
+                    fields?: readonly ({
+                        fieldId: string;
+                    } & {
+                        customTypes?: readonly {
+                            customTypeId: string;
+                            fields: readonly {
+                                fieldId: string;
+                            }[];
+                        }[];
+                    })[];
+                })[];
                 masks?: readonly string[];
                 tags?: readonly string[];
                 allowTargetBlank?: boolean;
@@ -1607,7 +1732,20 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                             useAsTitle?: boolean;
                             placeholder?: string;
                             select?: "media" | "document" | "web" | null;
-                            customtypes?: readonly string[];
+                            customtypes?: readonly ({
+                                customTypeId: string;
+                            } & {
+                                fields?: readonly ({
+                                    fieldId: string;
+                                } & {
+                                    customTypes?: readonly {
+                                        customTypeId: string;
+                                        fields: readonly {
+                                            fieldId: string;
+                                        }[];
+                                    }[];
+                                })[];
+                            })[];
                             masks?: readonly string[];
                             tags?: readonly string[];
                             allowTargetBlank?: boolean;
@@ -1780,7 +1918,20 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                             useAsTitle?: boolean;
                             placeholder?: string;
                             select?: "media" | "document" | "web" | null;
-                            customtypes?: readonly string[];
+                            customtypes?: readonly ({
+                                customTypeId: string;
+                            } & {
+                                fields?: readonly ({
+                                    fieldId: string;
+                                } & {
+                                    customTypes?: readonly {
+                                        customTypeId: string;
+                                        fields: readonly {
+                                            fieldId: string;
+                                        }[];
+                                    }[];
+                                })[];
+                            })[];
                             masks?: readonly string[];
                             tags?: readonly string[];
                             allowTargetBlank?: boolean;
@@ -1946,7 +2097,20 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                         useAsTitle?: boolean;
                                         placeholder?: string;
                                         select?: "media" | "document" | "web" | null;
-                                        customtypes?: readonly string[];
+                                        customtypes?: readonly ({
+                                            customTypeId: string;
+                                        } & {
+                                            fields?: readonly ({
+                                                fieldId: string;
+                                            } & {
+                                                customTypes?: readonly {
+                                                    customTypeId: string;
+                                                    fields: readonly {
+                                                        fieldId: string;
+                                                    }[];
+                                                }[];
+                                            })[];
+                                        })[];
                                         masks?: readonly string[];
                                         tags?: readonly string[];
                                         allowTargetBlank?: boolean;
@@ -2113,7 +2277,20 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                     useAsTitle?: boolean;
                                     placeholder?: string;
                                     select?: "media" | "document" | "web" | null;
-                                    customtypes?: readonly string[];
+                                    customtypes?: readonly ({
+                                        customTypeId: string;
+                                    } & {
+                                        fields?: readonly ({
+                                            fieldId: string;
+                                        } & {
+                                            customTypes?: readonly {
+                                                customTypeId: string;
+                                                fields: readonly {
+                                                    fieldId: string;
+                                                }[];
+                                            }[];
+                                        })[];
+                                    })[];
                                     masks?: readonly string[];
                                     tags?: readonly string[];
                                     allowTargetBlank?: boolean;
@@ -2272,7 +2449,20 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
                                     useAsTitle?: boolean;
                                     placeholder?: string;
                                     select?: "media" | "document" | "web" | null;
-                                    customtypes?: readonly string[];
+                                    customtypes?: readonly ({
+                                        customTypeId: string;
+                                    } & {
+                                        fields?: readonly ({
+                                            fieldId: string;
+                                        } & {
+                                            customTypes?: readonly {
+                                                customTypeId: string;
+                                                fields: readonly {
+                                                    fieldId: string;
+                                                }[];
+                                            }[];
+                                        })[];
+                                    })[];
                                     masks?: readonly string[];
                                     tags?: readonly string[];
                                     allowTargetBlank?: boolean;
@@ -2374,8 +2564,12 @@ export declare const CustomType: t.ExactC<t.IntersectionC<[t.TypeC<{
     status: t.BooleanC;
 }>, t.PartialC<{
     hash: t.StringC;
+    format: t.KeyofC<{
+        page: string;
+        custom: string;
+    }>;
 }>]>>;
-export type CustomType = t.TypeOf<typeof CustomType>;
+export declare type CustomType = t.TypeOf<typeof CustomType>;
 export declare function flattenWidgets(customType: CustomType): Array<[string, DynamicWidget]>;
 export declare function toStatic(customType: CustomType, sharedSlices: Map<string, SharedSlice>): StaticCustomType;
 export declare function validateSlices(customType: CustomType, sharedSlices: Map<string, SharedSlice>): Either<CustomTypeSlicesError, CustomType>;

package/lib/customtypes/CustomType.js CHANGED Viewed

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterMissingSharedSlices = exports.collectWidgets = exports.validateSlices = exports.toStatic = exports.flattenWidgets = exports.CustomType = exports.StaticCustomType = void 0;
+exports.filterMissingSharedSlices = exports.collectWidgets = exports.validateSlices = exports.toStatic = exports.flattenWidgets = exports.CustomType = exports.StaticCustomType = exports.CustomTypeFormat = void 0;
 const tslib_1 = require("tslib");
 const Either_1 = require("fp-ts/lib/Either");
-const t = tslib_1.__importStar(require("io-ts"));
+const t = (0, tslib_1.__importStar)(require("io-ts"));
 const withFallback_1 = require("io-ts-types/lib/withFallback");
 const validators_1 = require("../validators");
 const Section_1 = require("./Section");
+exports.CustomTypeFormat = {
+    page: "page",
+    custom: "custom",
+};
 class CustomTypeSlicesError extends Error {
     constructor(slices) {
         super();
@@ -43,6 +47,7 @@ function customTypeReader(codec) {
         }),
         t.partial({
             hash: t.string,
+            format: (0, withFallback_1.withFallback)(t.keyof(exports.CustomTypeFormat), "custom"),
         }),
     ]));
 }