@prismicio/types-internal 2.2.1 → 2.3.0

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

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.imageConverter = exports.convertImageView = void 0;
+const common_1 = require("../../../../common");
+const Objects_1 = require("../../../../utils/Objects");
+function convertImageView(inputImage, image) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    // We can do that because anyway all properties being read
+    const imageField = {
+        ...inputImage,
+        edit: {
+            x: 0,
+            y: 0,
+            zoom: 1,
+            ...inputImage.edit,
+        },
+        dimensions: (_a = inputImage.dimensions) !== null && _a !== void 0 ? _a : {},
+    };
+    return (0, Objects_1.withOptionals)({
+        origin: {
+            id: image.id,
+            url: image.origin_url,
+            // All images returned form Asset API should have width and height properties.
+            width: (_b = image.width) !== null && _b !== void 0 ? _b : 0,
+            height: (_c = image.height) !== null && _c !== void 0 ? _c : 0,
+        },
+        // All images returned form Asset API should have width and height properties.
+        // Image width and height will be only applied if there are no constraints and user didn't overwrite it
+        width: (_f = (_e = (_d = imageField === null || imageField === void 0 ? void 0 : imageField.dimensions) === null || _d === void 0 ? void 0 : _d.width) !== null && _e !== void 0 ? _e : image.width) !== null && _f !== void 0 ? _f : 0,
+        height: (_j = (_h = (_g = imageField === null || imageField === void 0 ? void 0 : imageField.dimensions) === null || _g === void 0 ? void 0 : _g.height) !== null && _h !== void 0 ? _h : image.height) !== null && _j !== void 0 ? _j : 0,
+        // If edit is not provided, we crop constraint width and height from the left upper corner.
+        // WARN: If constraints are greater than image dimensions cut outside the image (background will fill extra space).
+        edit: {
+            zoom: (_l = (_k = imageField.edit) === null || _k === void 0 ? void 0 : _k.zoom) !== null && _l !== void 0 ? _l : 1,
+            crop: {
+                x: (_o = (_m = imageField.edit) === null || _m === void 0 ? void 0 : _m.x) !== null && _o !== void 0 ? _o : 0,
+                y: (_q = (_p = imageField.edit) === null || _p === void 0 ? void 0 : _p.y) !== null && _q !== void 0 ? _q : 0,
+            },
+            background: (_s = (_r = imageField.edit) === null || _r === void 0 ? void 0 : _r.background) !== null && _s !== void 0 ? _s : (image.extension === "png" ? "transparent" : "#ffffff"),
+        },
+        url: image.url,
+    }, [
+        ["alt", (imageField === null || imageField === void 0 ? void 0 : imageField.alt) || image.alt],
+        ["credits", (imageField === null || imageField === void 0 ? void 0 : imageField.copyright) || image.credits],
+    ]);
+}
+exports.convertImageView = convertImageView;
+function convertThumbnails(imageField, assets) {
+    return Object.entries(imageField.thumbnails).reduce((acc, [thumbnailName, thumbnail]) => {
+        return {
+            ...acc,
+            [thumbnailName]: convertImageView(thumbnail, (0, common_1.getAssetOrThrow)(assets)(thumbnail.id)),
+        };
+    }, {});
+}
+// All assets from `imageField` must be present in `assets`
+// If not then function will throw an error
+const imageConverter = (imageField, assets) => {
+    if (!imageField)
+        return;
+    return {
+        ...convertImageView(imageField, (0, common_1.getAssetOrThrow)(assets)(imageField.id)),
+        thumbnails: convertThumbnails(imageField, assets),
+        __TYPE__: "ImageContent",
+    };
+};
+exports.imageConverter = imageConverter;

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

@@ -0,0 +1,4 @@
+import type { Asset } from "../../../../common";
+import type { LinkContent } from "../../../../content";
+import type { ImportLink } from "../../../validators";
+export declare const linkConverter: (field: ImportLink["value"], assets: Record<string, Asset | undefined>) => LinkContent | undefined;

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

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.linkConverter = void 0;
+const common_1 = require("../../../../common");
+const webLinkConverter = (field) => ({
+    value: {
+        url: field.url,
+        target: field.target,
+        __TYPE__: "ExternalLink",
+    },
+    __TYPE__: "LinkContent",
+});
+const documentLinkConverter = (field) => ({
+    value: {
+        id: field.id,
+        __TYPE__: "DocumentLink",
+    },
+    __TYPE__: "LinkContent",
+});
+const fileLinkConverter = (field, asset) => {
+    var _a;
+    return ({
+        value: {
+            id: field.id,
+            url: asset.origin_url,
+            name: (_a = asset.filename) !== null && _a !== void 0 ? _a : "unknown.jpg",
+            kind: asset.kind,
+            size: asset.size ? String(asset.size) : "0",
+            __TYPE__: "FileLink",
+        },
+        __TYPE__: "LinkContent",
+    });
+};
+const imageLinkConverter = (field, asset) => {
+    var _a, _b, _c;
+    return ({
+        value: {
+            id: field.id,
+            url: asset.origin_url,
+            height: String((_a = asset.height) !== null && _a !== void 0 ? _a : 1),
+            width: String((_b = asset.width) !== null && _b !== void 0 ? _b : 1),
+            name: (_c = asset.filename) !== null && _c !== void 0 ? _c : "unknown.jpg",
+            kind: asset.kind,
+            size: asset.size ? String(asset.size) : "0",
+            __TYPE__: "ImageLink",
+        },
+        __TYPE__: "LinkContent",
+    });
+};
+const linkConverter = (field, assets) => {
+    if (field === null) {
+        return;
+    }
+    switch (field.link_type) {
+        case "Web":
+            return webLinkConverter(field);
+        case "Document":
+            return documentLinkConverter(field);
+        case "Media": {
+            const asset = (0, common_1.getAssetOrThrow)(assets)(field.id);
+            switch (asset.kind) {
+                case "all":
+                    return fileLinkConverter(field, asset);
+                case "image":
+                    return imageLinkConverter(field, asset);
+            }
+        }
+    }
+};
+exports.linkConverter = linkConverter;

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

@@ -0,0 +1,5 @@
+import type { Asset } from "../../../../common";
+import type { Embed } from "../../../../common/Embed";
+import type { NestableContent } from "../../../../content";
+import type { ImportNestable } from "../../../validators";
+export declare function convertNestableWidget(field: ImportNestable, assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>): NestableContent | undefined;

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertNestableWidget = void 0;
+const _1 = require(".");
+function convertNestableWidget(field, assets, embeds) {
+    switch (field.type) {
+        case "Boolean":
+            return (0, _1.booleanConverter)(field.value);
+        case "Color":
+            return (0, _1.colorConverter)(field.value);
+        case "Select":
+            return (0, _1.selectConverter)(field.value);
+        case "Number":
+            return (0, _1.numberConverter)(field.value);
+        case "Text":
+            return (0, _1.textConverter)(field.value);
+        case "Date":
+            return (0, _1.dateConverter)(field.value);
+        case "Timestamp":
+            return (0, _1.timestampConverter)(field.value);
+        case "Embed":
+            return (0, _1.embedConverter)(field.value, embeds);
+        case "GeoPoint":
+            return (0, _1.geopointConverter)(field.value);
+        case "Link":
+            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)}`);
+    }
+}
+exports.convertNestableWidget = convertNestableWidget;

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

@@ -0,0 +1,3 @@
+import type { NumberContent } from "../../../../content";
+import type { ImportNumber } from "../../../validators";
+export declare const numberConverter: (field: ImportNumber["value"]) => NumberContent | undefined;

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.numberConverter = void 0;
+const numberConverter = (field) => {
+    if (field === null)
+        return;
+    return {
+        type: "Number",
+        value: field.toString(),
+        __TYPE__: "FieldContent",
+    };
+};
+exports.numberConverter = numberConverter;

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

@@ -0,0 +1,4 @@
+import type { Embed } from "../../../../../common";
+import type { EmbedBlock } from "../../../../../content";
+import type { ImportEmbedBlock } from "../../../../validators/fields/nestable/ImportRichText/blocks";
+export declare function embedBlockConverter(block: ImportEmbedBlock, embeds: Record<string, Embed | undefined>): EmbedBlock;

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.embedBlockConverter = void 0;
+const Embed_1 = require("../Embed");
+function embedBlockConverter(block, embeds) {
+    const embedData = (0, Embed_1.embedConverter)(block.oembed, embeds);
+    if (!embedData)
+        throw new Error("Failed to convert embed data");
+    return {
+        type: block.type,
+        data: embedData,
+    };
+}
+exports.embedBlockConverter = embedBlockConverter;

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

@@ -0,0 +1,4 @@
+import { Asset } from "../../../../../common";
+import type { ImageBlock } from "../../../../../content";
+import type { ImportImageBlock } from "../../../../validators/fields/nestable/ImportRichText/blocks";
+export declare function imageBlockConverter(block: ImportImageBlock, assets: Record<Asset["id"], Asset | undefined>): ImageBlock;

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.imageBlockConverter = void 0;
+const common_1 = require("../../../../../common");
+const Image_1 = require("../Image");
+function imageBlockConverter(block, assets) {
+    return {
+        type: block.type,
+        data: (0, Image_1.convertImageView)(block, (0, common_1.getAssetOrThrow)(assets)(block.id)),
+    };
+}
+exports.imageBlockConverter = imageBlockConverter;

package/lib/import/converters/fields/nestable/RichText/index.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/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.richTextConverter = void 0;
+const content_1 = require("../../../../../content");
+const embedBlock_1 = require("./embedBlock");
+const imageBlock_1 = require("./imageBlock");
+const textBlock_1 = require("./textBlock");
+const richTextConverter = (richTextField, assets, embeds) => {
+    if (richTextField === null)
+        return;
+    return {
+        __TYPE__: content_1.RichTextContentType,
+        value: richTextField.map((block) => {
+            if (block.type === "image")
+                return (0, imageBlock_1.imageBlockConverter)(block, assets);
+            else if (block.type === "embed")
+                return (0, embedBlock_1.embedBlockConverter)(block, embeds);
+            return (0, textBlock_1.textBlockConverter)(block, assets);
+        }),
+    };
+};
+exports.richTextConverter = richTextConverter;

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

@@ -0,0 +1,4 @@
+import type { Asset } from "../../../../../common";
+import type { TextBlock } from "../../../../../content";
+import type { ImportTextBlock } from "../../../../validators/fields/nestable/ImportRichText/blocks";
+export declare function textBlockConverter(block: ImportTextBlock, assets: Record<Asset["id"], Asset | undefined>): TextBlock;

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

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.textBlockConverter = void 0;
+const Link_1 = require("../Link");
+function textBlockConverter(block, assets) {
+    return {
+        type: block.type,
+        content: {
+            text: block.text,
+            ...(() => {
+                if (block.spans) {
+                    const convertedSpans = spansConverter(block.spans, assets);
+                    if (!convertedSpans)
+                        return {};
+                    return { spans: convertedSpans };
+                }
+                return {};
+            })(),
+        },
+        ...(block.direction ? { direction: block.direction } : {}),
+    };
+}
+exports.textBlockConverter = textBlockConverter;
+function spansConverter(spans, assets) {
+    return spans.reduce((acc, span) => {
+        switch (span.type) {
+            case "em":
+            case "strong":
+                return [...acc, span];
+            case "label":
+                return [
+                    ...acc,
+                    {
+                        ...span,
+                        data: span.data.label,
+                    },
+                ];
+            case "hyperlink": {
+                const convertedLink = (0, Link_1.linkConverter)(span.data, assets);
+                if (!convertedLink)
+                    return acc;
+                return [
+                    ...acc,
+                    {
+                        type: span.type,
+                        start: span.start,
+                        end: span.end,
+                        data: convertedLink.value,
+                    },
+                ];
+            }
+        }
+    }, []);
+}

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

@@ -0,0 +1,3 @@
+import type { SelectContent } from "../../../../content";
+import type { ImportSelect } from "../../../validators";
+export declare const selectConverter: (field: ImportSelect["value"]) => SelectContent | undefined;

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.selectConverter = void 0;
+const selectConverter = (field) => {
+    if (field === null)
+        return;
+    return {
+        type: "Select",
+        value: field,
+        __TYPE__: "FieldContent",
+    };
+};
+exports.selectConverter = selectConverter;

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

@@ -0,0 +1,3 @@
+import type { TextContent } from "../../../../content";
+import type { ImportText } from "../../../validators";
+export declare const textConverter: (field: ImportText["value"]) => TextContent | undefined;

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.textConverter = void 0;
+const textConverter = (field) => {
+    if (field === null)
+        return;
+    return {
+        type: "Text",
+        value: field,
+        __TYPE__: "FieldContent",
+    };
+};
+exports.textConverter = textConverter;

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

@@ -0,0 +1,3 @@
+import type { TimestampContent } from "../../../../content";
+import type { ImportTimestamp } from "../../../validators";
+export declare const timestampConverter: (field: ImportTimestamp["value"]) => TimestampContent | undefined;

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.timestampConverter = void 0;
+const timestampConverter = (field) => {
+    if (field === null)
+        return;
+    return {
+        type: "Timestamp",
+        value: field.toISOString(),
+        __TYPE__: "FieldContent",
+    };
+};
+exports.timestampConverter = timestampConverter;

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

@@ -0,0 +1,13 @@
+export * from "./Boolean";
+export * from "./Color";
+export * from "./Date";
+export * from "./Embed";
+export * from "./GeoPoint";
+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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./Boolean"), exports);
+(0, tslib_1.__exportStar)(require("./Color"), exports);
+(0, tslib_1.__exportStar)(require("./Date"), exports);
+(0, tslib_1.__exportStar)(require("./Embed"), exports);
+(0, tslib_1.__exportStar)(require("./GeoPoint"), exports);
+(0, tslib_1.__exportStar)(require("./Image"), exports);
+(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/converters/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Document";
+export * from "./fields";

package/lib/import/converters/index.js

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

package/lib/import/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./converters";
+export * from "./validators";

package/lib/import/index.js

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

package/lib/import/validators/Document.d.ts

@@ -0,0 +1,6 @@
+import * as t from "io-ts";
+import type { WidgetKey } from "../../common";
+import type { StaticCustomType } from "../../customtypes";
+import { ImportField } from "./fields/ImportField";
+export declare type ImportDocument = Record<WidgetKey, ImportField>;
+export declare const ImportDocument: (customType: StaticCustomType) => t.Type<ImportDocument, ImportDocument, unknown>;

package/lib/import/validators/Document.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportDocument = void 0;
+const tslib_1 = require("tslib");
+const fp_ts_1 = require("fp-ts");
+const Either_1 = require("fp-ts/Either");
+const function_1 = require("fp-ts/lib/function");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const customtypes_1 = require("../../customtypes");
+const Objects_1 = require("../../utils/Objects");
+const function_2 = require("../../validators/function");
+const ImportField_1 = require("./fields/ImportField");
+const rawImportDocument = (0, function_2.withCustomError)(t.UnknownRecord, () => "document is not an object");
+function validateField(document, customType) {
+    return (key, content, model) => {
+        // the field is not defined in the custom type -> extra field or typo
+        if (!model) {
+            const error = {
+                value: content,
+                context: [{ key: key, type: t.unknown }],
+                message: `The field ${key} is not part of the Custom type`,
+            };
+            return fp_ts_1.either.left([error]);
+        }
+        // retrieving the right codec then testing out fieldValue with it.
+        const { result, codec } = ImportField_1.ImportField.decode(model)(content);
+        // error.context is pointing at root when it should point to a `fieldKey`.
+        // We need to override the context to make it right.
+        if ((0, Either_1.isLeft)(result)) {
+            const errors = result.left.map((error) => {
+                const contextHead = error.context[0];
+                const context = [
+                    { key: "", actual: document, type: (0, exports.ImportDocument)(customType) },
+                    contextHead
+                        ? { ...contextHead, key: key }
+                        : { key: key, actual: content, type: codec },
+                    ...error.context.slice(1),
+                ];
+                return { ...error, context };
+            });
+            return fp_ts_1.either.left(errors);
+        }
+        return fp_ts_1.either.right(result.right);
+    };
+}
+function validateDocument(customType, rawDoc) {
+    const fieldModels = (0, customtypes_1.flattenCustomTypeFields)(customType);
+    const { document, errors } = Object.entries(rawDoc).reduce((acc, [fieldKey, fieldValue]) => {
+        const parsedField = validateField(rawDoc, customType)(fieldKey, fieldValue, fieldModels[fieldKey]);
+        if ((0, Either_1.isLeft)(parsedField))
+            return { ...acc, errors: [...acc.errors, ...parsedField.left] };
+        return {
+            ...acc,
+            document: { ...acc.document, [fieldKey]: parsedField.right },
+        };
+    }, { document: {}, errors: [] });
+    if (errors.length > 0)
+        return fp_ts_1.either.left(errors);
+    return fp_ts_1.either.right(document);
+}
+const ImportDocument = (customType) => new t.Type("ImportDocument", (u) => (0, Objects_1.isObject)(u), (raw) => {
+    return (0, function_1.pipe)(rawImportDocument.decode(raw), fp_ts_1.either.chain((doc) => validateDocument(customType, doc)));
+}, t.identity);
+exports.ImportDocument = ImportDocument;

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

@@ -0,0 +1,5 @@
+import * as t from "io-ts";
+export declare const ImportContent: <T extends "Boolean" | "Color" | "Date" | "Embed" | "GeoPoint" | "Image" | "IntegrationFields" | "Link" | "Number" | "Range" | "StructuredText" | "Select" | "Separator" | "Text" | "Timestamp" | "Group" | "Choice" | "Slices" | "UID", A, O = A>(type: T, valueCodec: t.Type<A, O, unknown>) => t.Type<{
+    type: T;
+    value: A;
+}, O, unknown>;

package/lib/import/validators/fields/ImportContent.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportContent = void 0;
+const tslib_1 = require("tslib");
+const fp_ts_1 = require("fp-ts");
+const function_1 = require("fp-ts/lib/function");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const Objects_1 = require("../../../utils/Objects");
+const ImportContent = (type, valueCodec) => new t.Type(`ImportField: ${valueCodec.name}`, (u) => {
+    if (!(0, Objects_1.isObject)(u))
+        return false;
+    return type === u["type"] && valueCodec.is(u["value"]);
+}, (u, c) => {
+    return (0, function_1.pipe)(valueCodec.validate(u, c), fp_ts_1.either.map((decodedValue) => {
+        return {
+            type,
+            value: decodedValue,
+        };
+    }));
+}, (field) => field.value);
+exports.ImportContent = ImportContent;