@prismicio/types-internal 2.2.0-alpha.16 → 2.2.0-alpha.18

package/lib/import/converters/fields/nestable/Image.d.ts

@@ -1,4 +1,6 @@
 import type { Asset } from "../../../../common";
-import type { ImageContent } from "../../../../content";
+import type { ImageContent, ImageContentView } from "../../../../content";
 import type { ImportImage } from "../../../validators";
+import type { ImportImageBlock } from "../../../validators/fields/nestable/ImportRichText/blocks";
+export declare const imageBlockConverter: (imageBlock: ImportImageBlock, assets: Record<Asset["id"], Asset | undefined>) => ImageContentView;
 export declare const imageConverter: (imageField: ImportImage["value"], assets: Record<Asset["id"], Asset | undefined>) => ImageContent | undefined;

package/lib/import/converters/fields/nestable/Image.js

@@ -1,10 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.imageConverter = void 0;
+exports.imageConverter = exports.imageBlockConverter = void 0;
 const common_1 = require("../../../../common");
 const Objects_1 = require("../../../../utils/Objects");
-function convertImage(imageField, image) {
+function convertImage(inputImage, image) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+    // We can do that because anyway all properties being read
+    const imageField = {
+        ...inputImage,
+        edit: "edit" in inputImage
+            ? inputImage.edit
+            : {
+                x: 0,
+                y: 0,
+                zoom: 1,
+            },
+        dimensions: "dimensions" in inputImage ? inputImage.dimensions : {},
+    };
     return (0, Objects_1.withOptionals)({
         origin: {
             id: image.id,
@@ -41,6 +53,10 @@ function convertThumbnails(imageField, assets) {
         };
     }, {});
 }
+const imageBlockConverter = (imageBlock, assets) => {
+    return convertImage(imageBlock, (0, common_1.getAssetOrThrow)(assets)(imageBlock.id));
+};
+exports.imageBlockConverter = imageBlockConverter;
 // All assets from `imageField` must be present in `assets`
 // If not then function will throw an error
 const imageConverter = (imageField, assets) => {

package/lib/import/converters/fields/nestable/Nestable.js

@@ -26,6 +26,8 @@ function convertNestableWidget(field, assets, embeds) {
             return (0, _1.linkConverter)(field.value, assets);
         case "Image":
             return (0, _1.imageConverter)(field.value, assets);
+        case "StructuredText":
+            return (0, _1.richTextConverter)(field.value, assets, embeds);
         default:
             throw new Error(`Unsupported type of nestable converter ${JSON.stringify(field)}`);
     }

package/lib/import/converters/fields/nestable/RichText.d.ts

@@ -0,0 +1,4 @@
+import type { Asset, Embed } from "../../../../common";
+import type { RichTextContent } from "../../../../content";
+import type { ImportRichText } from "../../../validators";
+export declare const richTextConverter: (richTextField: ImportRichText["value"], assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>) => RichTextContent | undefined;

package/lib/import/converters/fields/nestable/RichText.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.richTextConverter = void 0;
+const content_1 = require("../../../../content");
+const Embed_1 = require("./Embed");
+const Image_1 = require("./Image");
+const Link_1 = require("./Link");
+const richTextBlockConverter = (importBlock, assets, embeds) => {
+    var _a, _b, _c;
+    if (importBlock.type === "image") {
+        return {
+            type: importBlock.type,
+            data: (0, Image_1.imageBlockConverter)(importBlock, assets),
+        };
+    }
+    else if (importBlock.type === "embed") {
+        const embedData = (0, Embed_1.embedConverter)(importBlock.oembed, embeds);
+        if (!embedData)
+            throw new Error("Failed to convert embed data");
+        return {
+            type: importBlock.type,
+            data: embedData,
+        };
+    }
+    else {
+        // Text block
+        return {
+            type: importBlock.type,
+            direction: (_a = importBlock.direction) !== null && _a !== void 0 ? _a : "ltr",
+            content: {
+                text: importBlock.text,
+                spans: (_c = (_b = importBlock.spans) === null || _b === void 0 ? void 0 : _b.map((span) => {
+                    const linkData = span.type === "hyperlink"
+                        ? (0, Link_1.linkConverter)(span.data, assets)
+                        : undefined;
+                    return {
+                        type: span.type,
+                        start: span.start,
+                        end: span.end,
+                        data: linkData,
+                    };
+                })) !== null && _c !== void 0 ? _c : [],
+            },
+        };
+    }
+};
+const richTextConverter = (richTextField, assets, embeds) => {
+    if (richTextField === null)
+        return;
+    return {
+        __TYPE__: content_1.RichTextContentType,
+        value: richTextField.map((block) => richTextBlockConverter(block, assets, embeds)),
+    };
+};
+exports.richTextConverter = richTextConverter;

package/lib/import/converters/fields/nestable/index.d.ts

@@ -7,6 +7,7 @@ export * from "./Image";
 export * from "./Link";
 export * from "./Nestable";
 export * from "./Number";
+export * from "./RichText";
 export * from "./Select";
 export * from "./Text";
 export * from "./Timestamp";

package/lib/import/converters/fields/nestable/index.js

@@ -10,6 +10,7 @@ const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./Link"), exports);
 (0, tslib_1.__exportStar)(require("./Nestable"), exports);
 (0, tslib_1.__exportStar)(require("./Number"), exports);
+(0, tslib_1.__exportStar)(require("./RichText"), exports);
 (0, tslib_1.__exportStar)(require("./Select"), exports);
 (0, tslib_1.__exportStar)(require("./Text"), exports);
 (0, tslib_1.__exportStar)(require("./Timestamp"), exports);

package/lib/import/validators/fields/ImportField.d.ts

@@ -50,6 +50,9 @@ export declare const ImportField: {
         }, {
             link_type: "Document" | "Web" | "Media";
         } | undefined, unknown> | import("io-ts").Type<{
+            type: "StructuredText";
+            value: import("./nestable").ImportBlock[] | null;
+        }, unknown[] | undefined, unknown> | import("io-ts").Type<{
             type: "Number";
             value: number | null;
         }, number | undefined, unknown> | import("io-ts").Type<{
@@ -74,6 +77,9 @@ export declare const ImportField: {
         }> | import("fp-ts/lib/Either").Right<{
             type: "Number";
             value: number | null;
+        }> | import("fp-ts/lib/Either").Right<{
+            type: "StructuredText";
+            value: import("./nestable").ImportBlock[] | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Link";
             value: ({

package/lib/import/validators/fields/ImportSlices/SharedSlice/SharedSlice.js

@@ -8,7 +8,7 @@ const t = (0, tslib_1.__importStar)(require("io-ts"));
 const validators_1 = require("../../../../../validators");
 const function_2 = require("../../../../../validators/function");
 const fields_1 = require("./fields");
-const SharedSliceShape = t.type({
+const SharedSliceShape = t.strict({
     id: fields_1.OptionalSharedSliceId,
     slice_type: validators_1.NonEmptyString,
     name: validators_1.String,

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceType.js

@@ -12,7 +12,7 @@ const utils_1 = require("../utils");
  * slice_type - the validated slice_type
  * slice - SharedSlice custom type data matching the slice_type. We return it alongside the validated slice_type, because it is needed to decode the 'variation' field in the SharedSlice (see SharedSliceVariation.ts)
  */
-const SharedSliceTypeShape = t.type({
+const SharedSliceTypeShape = t.strict({
     slice_type: validators_1.NonEmptyString,
     slice: customtypes_1.SharedSlice,
 });

package/lib/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceVariation.js

@@ -12,7 +12,7 @@ const utils_1 = require("../utils");
  * variation - the validated variation of the slice
  * data - Variation data matching the variation. We return it alongside the validated variation, because it is needed to decode the 'primary' and 'items' fields in the SharedSlice.
  */
-const SharedSliceVariationShape = t.type({
+const SharedSliceVariationShape = t.strict({
     variation: validators_1.NonEmptyString,
     data: customtypes_1.Variation,
 });

package/lib/import/validators/fields/nestable/Embed.d.ts

@@ -1,4 +1,7 @@
 import * as t from "io-ts";
+export declare const ImportEmbedValue: t.ExactC<t.TypeC<{
+    embed_url: t.Type<string, string, unknown>;
+}>>;
 export declare const ImportEmbed: t.Type<{
     type: "Embed";
     value: {

package/lib/import/validators/fields/nestable/Embed.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportEmbed = void 0;
+exports.ImportEmbed = exports.ImportEmbedValue = void 0;
 const tslib_1 = require("tslib");
-const Either = (0, tslib_1.__importStar)(require("fp-ts/Either"));
-const function_1 = require("fp-ts/lib/function");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const validators_1 = require("../../../../validators");
 const ImportContent_1 = require("../ImportContent");
@@ -27,10 +25,7 @@ const EmbedUrl = new t.Type("EmbedUrl", (u) => isValidHttpUrl(u), (u, c) => {
         return t.failure(u, c, "The value must be a valid http/https url");
     }
 }, t.identity);
-const EmbedProto = t.type({
+exports.ImportEmbedValue = t.strict({
     embed_url: EmbedUrl,
 });
-const Embed = new t.Type("ImportEmbedValue", (u) => EmbedProto.is(u), (u) => {
-    return (0, function_1.pipe)(EmbedProto.decode(u), Either.map((parsed) => ({ embed_url: parsed.embed_url })));
-}, t.identity);
-exports.ImportEmbed = (0, ImportContent_1.ImportContent)("Embed", (0, validators_1.EmptyObjectOrElse)(Embed));
+exports.ImportEmbed = (0, ImportContent_1.ImportContent)("Embed", (0, validators_1.EmptyObjectOrElse)(exports.ImportEmbedValue));

package/lib/import/validators/fields/nestable/GeoPoint.js

@@ -6,8 +6,8 @@ const t = (0, tslib_1.__importStar)(require("io-ts"));
 const validators_1 = require("../../../../validators");
 const function_1 = require("../../../../validators/function");
 const ImportContent_1 = require("../ImportContent");
-const GeooPoint = (0, function_1.withCustomError)(t.strict({
+const GeoPoint = (0, function_1.withCustomError)(t.strict({
     latitude: (0, validators_1.NumberRange)(-90, 90, "latitude"),
     longitude: (0, validators_1.NumberRange)(-180, 180, "longitude"),
 }), () => "GeoPoint must be an object with the properties `latitude` and `longitude` between the given ranges");
-exports.ImportGeoPoint = (0, ImportContent_1.ImportContent)("GeoPoint", (0, validators_1.EmptyObjectOrElse)(GeooPoint));
+exports.ImportGeoPoint = (0, ImportContent_1.ImportContent)("GeoPoint", (0, validators_1.EmptyObjectOrElse)(GeoPoint));

package/lib/import/validators/fields/nestable/Image/default.d.ts

@@ -0,0 +1,22 @@
+import * as t from "io-ts";
+export declare const defaultImportImage: (field?: ({
+    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;
+        })[];
+    };
+}) | undefined) => t.Type<Record<never, never>, {
+    [key: string]: unknown;
+}, unknown>;

package/lib/import/validators/fields/nestable/Image/default.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultImportImage = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const validators_1 = require("../../../../../validators");
+const function_1 = require("../../../../../validators/function");
+const defaultImportImage = (field) => {
+    var _a;
+    // If there is not thumbnails we expect an empty object
+    if (!((_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.thumbnails) || !field.config.thumbnails.length)
+        return validators_1.EmptyObject;
+    // If there are thumbnails, we expect an object with thumbnails as empty objects
+    return (0, function_1.withCustomError)(t.strict(field.config.thumbnails.reduce((acc, thumbnail) => ({
+        ...acc,
+        [thumbnail.name]: validators_1.EmptyObject,
+    }), {})), () => "The value must be an object");
+};
+exports.defaultImportImage = defaultImportImage;

package/lib/import/validators/fields/nestable/Image/index.d.ts

@@ -1,5 +1,24 @@
 import * as t from "io-ts";
 import type { ImageFieldWithThumbnails } from "./model";
+export declare const ImageFieldCodec: (field?: ({
+    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;
+        })[];
+    };
+}) | undefined) => t.Type<ImageFieldWithThumbnails, ImageFieldWithThumbnails, unknown>;
 export declare const ImportImage: (field?: ({
     type: "Image";
 } & {

package/lib/import/validators/fields/nestable/Image/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportImage = void 0;
+exports.ImportImage = exports.ImageFieldCodec = void 0;
 const tslib_1 = require("tslib");
 const Either_1 = require("fp-ts/Either");
 const function_1 = require("fp-ts/function");
@@ -8,34 +8,34 @@ const t = (0, tslib_1.__importStar)(require("io-ts"));
 const validators_1 = require("../../../../../validators");
 const function_2 = require("../../../../../validators/function");
 const ImportContent_1 = require("../../ImportContent");
-const Decoder_1 = require("./Decoder");
-const Validator_1 = require("./Validator");
-const defaultImage = (field) => {
-    var _a;
-    // If there is not thumbnails we expect an empty object
-    if (!((_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.thumbnails) || !field.config.thumbnails.length)
-        return validators_1.EmptyObject;
-    // If there are thumbnails, we expect an object with thumbnails as empty objects
-    return (0, function_2.withCustomError)(t.strict(field.config.thumbnails.reduce((acc, thumbnail) => ({
-        ...acc,
-        [thumbnail.name]: validators_1.EmptyObject,
-    }), {})), () => "The value must be an object");
-};
-const ImageField = (field) => new t.Type("ImageField", (u) => Validator_1.ImageFieldValidator.is(u) &&
+const default_1 = require("./default");
+const merge_1 = require("./merge");
+const validators_2 = require("./validators");
+/* For code clarity, the output of this validator will be simplified
+ *
+ *  Input -> type ImageAPIV2 = ImportImageView & ImportThumbnails
+ *  Output -> type ImageWithThumbnails 👇
+ */
+const ImageFieldCodec = (field) => new t.Type("ImageField", (u) => validators_2.ImportImageView.is(u) &&
     "thumbnails" in u &&
-    Validator_1.ThumbnailsValidator.is(u["thumbnails"]), (u, ctx) => {
-    return (0, function_1.pipe)(Validator_1.ImageFieldValidator.validate(u, ctx), (0, Either_1.chain)((mainImage) => {
-        const { id, dimensions, edit, copyright, alt, ...maybeThumbnails } = mainImage;
-        return (0, function_1.pipe)(Validator_1.ThumbnailsValidator.validate(maybeThumbnails, ctx), (0, Either_1.map)((thumbnails) => {
+    validators_2.ImportThumbnails.is(u["thumbnails"]), (u, ctx) => {
+    return (0, function_1.pipe)(
+    // Validating the higher level image
+    validators_2.ImportImageView.validate(u, ctx), (0, Either_1.chain)((imageApiV2) => {
+        const { id, dimensions, edit, copyright, alt, ...thumbnails } = imageApiV2;
+        return (0, function_1.pipe)(
+        // Validating the thumbnails
+        validators_2.ImportThumbnails.validate(thumbnails, ctx), (0, Either_1.map)((thumbnails) => {
             var _a;
             return ({
-                ...(0, Decoder_1.decodeImageField)(mainImage, mainImage, (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.constraint),
-                thumbnails: (0, Decoder_1.decodeThumbnails)(mainImage, thumbnails, field),
+                ...(0, merge_1.mergeImageViewWithCtConstraints)(imageApiV2, imageApiV2, (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.constraint),
+                thumbnails: (0, merge_1.mergeThumbnailsWithCtConstraints)(thumbnails, imageApiV2, field),
             });
         }));
     }));
 }, t.identity);
-const ImageCodec = (field) => (0, function_2.withCustomError)((0, validators_1.DefaultOrElse)(defaultImage(field))(ImageField(field)), () => "An image field must be an object");
+exports.ImageFieldCodec = ImageFieldCodec;
+const ImageCodec = (field) => (0, function_2.withCustomError)((0, validators_1.DefaultOrElse)((0, default_1.defaultImportImage)(field))((0, exports.ImageFieldCodec)(field)), () => "An image field must be an object");
 const ImportImage = (field) => (0, ImportContent_1.ImportContent)("Image", ImageCodec(field));
 exports.ImportImage = ImportImage;
 (0, tslib_1.__exportStar)(require("./model"), exports);

package/lib/import/validators/fields/nestable/Image/merge.d.ts

@@ -0,0 +1,23 @@
+import type ImageConstraint from "../../../../../customtypes/widgets/shared/ImageConstraint";
+import type { ImageField } from "./model";
+import type { ImportImageView, ImportThumbnails } from "./validators";
+export declare const mergeImageViewWithCtConstraints: (image: ImportImageView | undefined, defaultImage: ImportImageView, constraints: ImageConstraint | undefined) => ImageField;
+export declare const mergeThumbnailsWithCtConstraints: (thumbnails: ImportThumbnails, defaultImage: ImportImageView, field?: ({
+    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;
+        })[];
+    };
+}) | undefined) => {};

package/lib/import/validators/fields/nestable/Image/{Decoder.js → merge.js}

@@ -1,18 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decodeThumbnails = exports.decodeImageField = void 0;
-// This function merges user input with custom type constraints.
-// If `image` is missing, `mainImage` is used for the encoding
-// (case when user input lacks thumbnail definition)
-const decodeImageField = (image, mainImage, constraints) => {
+exports.mergeThumbnailsWithCtConstraints = exports.mergeImageViewWithCtConstraints = void 0;
+/* This function merges user input with custom type constraints.
+ *  If a thumbnails' data are missing (`image`) then the default is used (`defaultImage`)
+ */
+const mergeImageViewWithCtConstraints = (image, defaultImage, constraints) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
     const background = (_a = image === null || image === void 0 ? void 0 : image.edit) === null || _a === void 0 ? void 0 : _a.background;
-    const width = (_d = (_b = constraints === null || constraints === void 0 ? void 0 : constraints.width) !== null && _b !== void 0 ? _b : (_c = image === null || image === void 0 ? void 0 : image.dimensions) === null || _c === void 0 ? void 0 : _c.width) !== null && _d !== void 0 ? _d : (_e = mainImage.dimensions) === null || _e === void 0 ? void 0 : _e.width;
-    const height = (_h = (_f = constraints === null || constraints === void 0 ? void 0 : constraints.height) !== null && _f !== void 0 ? _f : (_g = image === null || image === void 0 ? void 0 : image.dimensions) === null || _g === void 0 ? void 0 : _g.height) !== null && _h !== void 0 ? _h : (_j = mainImage.dimensions) === null || _j === void 0 ? void 0 : _j.height;
+    const width = (_d = (_b = constraints === null || constraints === void 0 ? void 0 : constraints.width) !== null && _b !== void 0 ? _b : (_c = image === null || image === void 0 ? void 0 : image.dimensions) === null || _c === void 0 ? void 0 : _c.width) !== null && _d !== void 0 ? _d : (_e = defaultImage === null || defaultImage === void 0 ? void 0 : defaultImage.dimensions) === null || _e === void 0 ? void 0 : _e.width;
+    const height = (_h = (_f = constraints === null || constraints === void 0 ? void 0 : constraints.height) !== null && _f !== void 0 ? _f : (_g = image === null || image === void 0 ? void 0 : image.dimensions) === null || _g === void 0 ? void 0 : _g.height) !== null && _h !== void 0 ? _h : (_j = defaultImage === null || defaultImage === void 0 ? void 0 : defaultImage.dimensions) === null || _j === void 0 ? void 0 : _j.height;
     const alt = image === null || image === void 0 ? void 0 : image.alt;
     const copyright = image === null || image === void 0 ? void 0 : image.copyright;
     return {
-        id: (_k = image === null || image === void 0 ? void 0 : image.id) !== null && _k !== void 0 ? _k : mainImage === null || mainImage === void 0 ? void 0 : mainImage.id,
+        id: (_k = image === null || image === void 0 ? void 0 : image.id) !== null && _k !== void 0 ? _k : defaultImage === null || defaultImage === void 0 ? void 0 : defaultImage.id,
         edit: {
             x: (_m = (_l = image === null || image === void 0 ? void 0 : image.edit) === null || _l === void 0 ? void 0 : _l.x) !== null && _m !== void 0 ? _m : 0,
             y: (_p = (_o = image === null || image === void 0 ? void 0 : image.edit) === null || _o === void 0 ? void 0 : _o.y) !== null && _p !== void 0 ? _p : 0,
@@ -27,14 +27,18 @@ const decodeImageField = (image, mainImage, constraints) => {
         ...(copyright !== undefined ? { copyright } : {}),
     };
 };
-exports.decodeImageField = decodeImageField;
-// Merges provided thumbnails with custom type constraints.
-// If any thumbnail is missing, it is created using the origin image (`mainImage`)
-const decodeThumbnails = (mainImage, thumbnails, field) => {
+exports.mergeImageViewWithCtConstraints = mergeImageViewWithCtConstraints;
+/* This function handles each thumbnail defined in the custom type.
+ *
+ *  For each of them it merges the user input with custom type constraints.
+ *
+ *  If a thumbnail is missing, the data from the default image is used.
+ */
+const mergeThumbnailsWithCtConstraints = (thumbnails, defaultImage, field) => {
     var _a, _b, _c;
     return (_c = (_b = (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.thumbnails) === null || _b === void 0 ? void 0 : _b.reduce((acc, thumbnail) => ({
         ...acc,
-        [thumbnail.name]: (0, exports.decodeImageField)(thumbnails[thumbnail.name], mainImage, thumbnail),
+        [thumbnail.name]: (0, exports.mergeImageViewWithCtConstraints)(thumbnails[thumbnail.name], defaultImage, thumbnail),
     }), {})) !== null && _c !== void 0 ? _c : {};
 };
-exports.decodeThumbnails = decodeThumbnails;
+exports.mergeThumbnailsWithCtConstraints = mergeThumbnailsWithCtConstraints;

package/lib/import/validators/fields/nestable/Image/{Validator.d.ts → validators.d.ts}

@@ -1,5 +1,5 @@
 import * as t from "io-ts";
-export declare const ImageFieldValidator: t.IntersectionC<[t.TypeC<{
+export declare const ImportImageView: t.IntersectionC<[t.TypeC<{
     id: t.StringC;
 }>, t.PartialC<{
     dimensions: t.PartialC<{
@@ -15,7 +15,8 @@ export declare const ImageFieldValidator: t.IntersectionC<[t.TypeC<{
     copyright: t.UnionC<[t.StringC, t.NullC]>;
     alt: t.UnionC<[t.StringC, t.NullC]>;
 }>]>;
-export declare const ThumbnailsValidator: t.RecordC<t.StringC, t.IntersectionC<[t.TypeC<{
+export declare type ImportImageView = t.TypeOf<typeof ImportImageView>;
+export declare const ImportThumbnails: t.RecordC<t.StringC, t.IntersectionC<[t.TypeC<{
     id: t.StringC;
 }>, t.PartialC<{
     dimensions: t.PartialC<{
@@ -31,3 +32,4 @@ export declare const ThumbnailsValidator: t.RecordC<t.StringC, t.IntersectionC<[
     copyright: t.UnionC<[t.StringC, t.NullC]>;
     alt: t.UnionC<[t.StringC, t.NullC]>;
 }>]>>;
+export declare type ImportThumbnails = t.TypeOf<typeof ImportThumbnails>;

package/lib/import/validators/fields/nestable/Image/{Validator.js → validators.js}

@@ -1,27 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ThumbnailsValidator = exports.ImageFieldValidator = void 0;
+exports.ImportThumbnails = exports.ImportImageView = void 0;
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const BasicTypes_1 = require("../../../../../validators/BasicTypes");
 const function_1 = require("../../../../../validators/function");
-exports.ImageFieldValidator = (0, function_1.withCustomError)(t.intersection([
+exports.ImportImageView = (0, function_1.withCustomError)(t.intersection([
     t.type({
+        // Image Id
         id: BasicTypes_1.String,
     }),
     t.partial({
+        // Dimensions here will be used if they are not defined in the custom type
         dimensions: (0, function_1.withCustomError)(t.partial({
             width: BasicTypes_1.Number,
             height: BasicTypes_1.Number,
         }), () => "The value must be an object"),
+        // Crop information
         edit: (0, function_1.withCustomError)(t.partial({
             x: BasicTypes_1.Number,
             y: BasicTypes_1.Number,
             zoom: BasicTypes_1.Number,
             background: BasicTypes_1.String,
         }), () => "The value must be an object"),
+        // Copyrights and alt are set in the Asset by default but they can be overrided
         copyright: BasicTypes_1.StringOrNull,
         alt: BasicTypes_1.StringOrNull,
     }),
 ]), () => "The value must be an object");
-exports.ThumbnailsValidator = t.record(t.string, exports.ImageFieldValidator);
+exports.ImportThumbnails = t.record(t.string, exports.ImportImageView);

package/lib/import/validators/fields/nestable/ImportRichText/ImportBlock.d.ts

@@ -0,0 +1,6 @@
+import * as t from "io-ts";
+import { ImportBlockType, ImportEmbedBlock, ImportImageBlock, ImportTextBlock } from "./blocks";
+export declare type ImportBlock = ImportTextBlock | ImportImageBlock | ImportEmbedBlock;
+export declare const ImportBlock: (allowedBlockTypes: string[]) => t.Type<ImportBlock, {
+    type: ImportBlockType;
+}, unknown>;

package/lib/import/validators/fields/nestable/ImportRichText/ImportBlock.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportBlock = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const function_1 = require("../../../../../validators/function");
+const blocks_1 = require("./blocks");
+const ImportBlock = (allowedBlockTypes) => (0, function_1.withCustomError)(t
+    .type({
+    type: (0, blocks_1.ImportBlockType)(allowedBlockTypes),
+})
+    .pipe(new t.Type("ImportBlock", (u) => t
+    .union([blocks_1.ImportTextBlock, blocks_1.ImportImageBlock, blocks_1.ImportEmbedBlock])
+    .is(u), (u, c) => {
+    if (u.type === "image") {
+        return blocks_1.ImportImageBlock.validate(u, c);
+    }
+    else if (u.type === "embed") {
+        return blocks_1.ImportEmbedBlock.validate(u, c);
+    }
+    else {
+        return blocks_1.ImportTextBlock.validate(u, c);
+    }
+}, t.identity)), () => "Rich text block must be an object");
+exports.ImportBlock = ImportBlock;

package/lib/import/validators/fields/nestable/ImportRichText/ImportRichText.d.ts

@@ -0,0 +1,24 @@
+import * as t from "io-ts";
+import { ImportBlock } from "./ImportBlock";
+export declare const ImportRichText: (customType?: ({
+    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;
+    };
+}) | undefined) => t.Type<{
+    type: "StructuredText";
+    value: ImportBlock[] | null;
+}, unknown[] | undefined, unknown>;
+export declare type ImportRichText = t.TypeOf<ReturnType<typeof ImportRichText>>;

package/lib/import/validators/fields/nestable/ImportRichText/ImportRichText.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportRichText = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const validators_1 = require("../../../../../validators");
+const function_1 = require("../../../../../validators/function");
+const ImportContent_1 = require("../../ImportContent");
+const ImportBlock_1 = require("./ImportBlock");
+const ImportRichText = (customType) => (0, ImportContent_1.ImportContent)("StructuredText", (0, validators_1.EmptyArrayOrElse)((0, function_1.withCustomError)(t.array(t.unknown).pipe(new t.Type("RichTextField", (u) => t.array((0, ImportBlock_1.ImportBlock)([])).is(u), (u, c) => {
+    var _a, _b, _c, _d;
+    const single = (_b = (_a = customType === null || customType === void 0 ? void 0 : customType.config) === null || _a === void 0 ? void 0 : _a.single) === null || _b === void 0 ? void 0 : _b.split(",");
+    const multi = (_d = (_c = customType === null || customType === void 0 ? void 0 : customType.config) === null || _c === void 0 ? void 0 : _c.multi) === null || _d === void 0 ? void 0 : _d.split(",");
+    if (multi) {
+        return t.array((0, ImportBlock_1.ImportBlock)(multi)).validate(u, c);
+    }
+    else if (single) {
+        return u.length > 1
+            ? t.failure(u, c, "This field only allows one block")
+            : t.array((0, ImportBlock_1.ImportBlock)(single)).validate(u, c);
+    }
+    else {
+        throw new Error("Rich text config must have either a 'single' or 'multi' field defined");
+    }
+}, t.identity)), () => "Rich text field must be an array")));
+exports.ImportRichText = ImportRichText;

package/lib/import/validators/fields/nestable/ImportRichText/blocks/ImportBlockType.d.ts

@@ -0,0 +1,6 @@
+import * as t from "io-ts";
+import { ImportEmbedBlockType } from "./ImportEmbedBlock";
+import { ImportImageBlockType } from "./ImportImageBlock";
+import { ImportTextBlockType } from "./ImportTextBlock";
+export declare type ImportBlockType = ImportTextBlockType | ImportImageBlockType | ImportEmbedBlockType;
+export declare const ImportBlockType: (allowedBlockTypes: string[]) => t.Type<ImportBlockType, ImportBlockType, unknown>;

package/lib/import/validators/fields/nestable/ImportRichText/blocks/ImportBlockType.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportBlockType = void 0;
+const tslib_1 = require("tslib");
+const E = (0, tslib_1.__importStar)(require("fp-ts/Either"));
+const function_1 = require("fp-ts/function");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const function_2 = require("../../../../../../validators/function");
+const ImportEmbedBlock_1 = require("./ImportEmbedBlock");
+const ImportImageBlock_1 = require("./ImportImageBlock");
+const ImportTextBlock_1 = require("./ImportTextBlock");
+const ImportBlockTypeValidator = (0, function_2.withCustomError)(t.union([ImportTextBlock_1.ImportTextBlockType, ImportImageBlock_1.ImportImageBlockType, ImportEmbedBlock_1.ImportEmbedBlockType]), () => `Invalid block type. Supported block types are: ${Object.keys(ImportTextBlock_1.ImportTextBlockType.keys).join(", ")}, ${ImportImageBlock_1.ImportImageBlockType.value}, ${ImportEmbedBlock_1.ImportEmbedBlockType.value}`);
+const ImportBlockType = (allowedBlockTypes) => new t.Type("ImportBlockType", (u) => ImportBlockTypeValidator.is(u), (u, c) => {
+    return (0, function_1.pipe)(ImportBlockTypeValidator.validate(u, c), E.chain((validBlockType) => allowedBlockTypes.includes(validBlockType)
+        ? t.success(validBlockType)
+        : t.failure(u, c, `The block type '${validBlockType}' is not allowed in your document type. Enable the type for this rich text field to create the document.`)));
+}, t.identity);
+exports.ImportBlockType = ImportBlockType;