@prismicio/types-internal 2.2.1-alpha.0 → 2.2.1

package/lib/common/UUID.d.ts

@@ -1,7 +1,6 @@
 import * as t from "io-ts";
-interface UUIDBrand {
+export interface UUIDBrand {
     readonly UUID: unique symbol;
 }
 export declare const UUID: t.BrandC<t.StringC, UUIDBrand>;
 export declare type UUID = t.TypeOf<typeof UUID>;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "2.2.1-alpha.0",
+	"version": "2.2.1",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",

package/src/common/UUID.ts

@@ -3,7 +3,7 @@ import { validate as validateUUID } from "uuid"
 
 import { withCustomError } from "../validators/function"
 
-interface UUIDBrand {
+export interface UUIDBrand {
 	readonly UUID: unique symbol
 }
 

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

@@ -1,4 +0,0 @@
-import type { Asset, Embed } from "../../common";
-import type { Document } from "../../content";
-import type { ImportDocument } from "../validators";
-export declare function convertImportToContent(document: ImportDocument, assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>): Document;

package/lib/import/converters/Document.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertImportToContent = void 0;
-const fields_1 = require("./fields");
-function convertImportToContent(document, assets, embeds) {
-    return Object.entries(document).reduce((acc, [fieldKey, fieldValue]) => {
-        const newFieldValue = convertWidget(fieldValue, assets, embeds);
-        return newFieldValue ? { ...acc, [fieldKey]: newFieldValue } : acc;
-    }, {});
-}
-exports.convertImportToContent = convertImportToContent;
-function convertWidget(field, assets, embeds) {
-    switch (field.type) {
-        case "Slices":
-            return (0, fields_1.importSlicesConverter)(field.value, assets, embeds);
-        case "Group":
-            return (0, fields_1.importGroupConverter)(field.value, assets, embeds);
-        default:
-            return (0, fields_1.convertNestableWidget)(field, assets, embeds);
-    }
-}

package/lib/import/converters/fields/Group.d.ts

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

package/lib/import/converters/fields/Group.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importGroupConverter = void 0;
-const content_1 = require("../../../content");
-const RepeatableZone_1 = require("./RepeatableZone");
-const importGroupConverter = (field, assets, embeds) => {
-    if (field === null)
-        return;
-    return {
-        __TYPE__: content_1.GroupContentType,
-        value: (0, RepeatableZone_1.repeatableZoneConverter)(field, assets, embeds),
-    };
-};
-exports.importGroupConverter = importGroupConverter;

package/lib/import/converters/fields/RepeatableZone.d.ts

@@ -1,317 +0,0 @@
-import type { Asset, Embed } from "../../../common";
-export declare const repeatableZoneConverter: (zone: import("../../validators").RepeatableZoneItem[], assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>) => {
-    __TYPE__: "GroupItemContent";
-    value: [string, {
-        type: string;
-        __TYPE__: "EmptyContent";
-    } | {
-        __TYPE__: "BooleanContent";
-        value: boolean;
-    } | ({
-        embed_url: string;
-        type: string;
-    } & {
-        version?: string | number | null;
-        title?: string | null | undefined;
-        author_name?: string | null | undefined;
-        author_url?: string | null | undefined;
-        provider_name?: string | null | undefined;
-        provider_url?: string | null | undefined;
-        cache_age?: string | number | null;
-        thumbnail_url?: string | null | undefined;
-        thumbnail_width?: number | null | undefined;
-        thumbnail_height?: number | null | undefined;
-        html?: string | null | undefined;
-    } & {
-        __TYPE__: "EmbedContent";
-        all: unknown;
-    }) | {
-        type: "Color";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | {
-        type: "Date";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | {
-        type: "Number";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | {
-        type: "Range";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | {
-        type: "Select";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | {
-        type: "Text";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | {
-        type: "Timestamp";
-        value: string;
-        __TYPE__: "FieldContent";
-    } | ({
-        position: {
-            lat: number;
-            lng: number;
-        };
-    } & {
-        __TYPE__: "GeoPointContent";
-    }) | ({
-        origin: {
-            id: string;
-            url: string;
-            width: number;
-            height: number;
-        };
-        width: number;
-        height: number;
-        edit: {
-            zoom: number;
-            crop: {
-                x: number;
-                y: number;
-            };
-            background: string;
-        };
-    } & {
-        url?: string;
-        credits?: string | null;
-        alt?: string | null;
-        provider?: string | null | undefined;
-    } & {
-        thumbnails?: {
-            [x: string]: {
-                origin: {
-                    id: string;
-                    url: string;
-                    width: number;
-                    height: number;
-                };
-                width: number;
-                height: number;
-                edit: {
-                    zoom: number;
-                    crop: {
-                        x: number;
-                        y: number;
-                    };
-                    background: string;
-                };
-            } & {
-                url?: string;
-                credits?: string | null;
-                alt?: string | null;
-                provider?: string | null | undefined;
-            };
-        };
-    } & {
-        __TYPE__: "ImageContent";
-    }) | {
-        __TYPE__: "IntegrationFieldsContent";
-        value: string;
-    } | {
-        __TYPE__: "LinkContent";
-        value: ({
-            __TYPE__: "ImageLink";
-        } & {
-            id: string;
-            url: string;
-            height: string;
-            width: string;
-            size: string;
-            name: string;
-            kind: string;
-        } & {
-            date?: string | null | undefined;
-        }) | ({
-            id: string;
-            url: string;
-            name: string;
-            kind: string;
-            size: string;
-        } & {
-            date?: string | null | undefined;
-        } & {
-            __TYPE__: "FileLink";
-        } & {
-            size?: string;
-        }) | ({
-            __TYPE__: "DocumentLink";
-        } & {
-            id: string;
-        }) | ({
-            __TYPE__: "ExternalLink";
-        } & {
-            url: string;
-        } & {
-            kind?: "web";
-            target?: string | null | undefined;
-            preview?: {
-                title?: string;
-            } | null | undefined;
-        });
-    } | {
-        __TYPE__: "StructuredTextContent";
-        value: (({
-            type: "image";
-            data: {
-                origin: {
-                    id: string;
-                    url: string;
-                    width: number;
-                    height: number;
-                };
-                width: number;
-                height: number;
-                edit: {
-                    zoom: number;
-                    crop: {
-                        x: number;
-                        y: number;
-                    };
-                    background: string;
-                };
-            } & {
-                url?: string;
-                credits?: string | null;
-                alt?: string | null;
-                provider?: string | null | undefined;
-            } & {
-                linkTo?: ({
-                    __TYPE__: "ImageLink";
-                } & {
-                    id: string;
-                    url: string;
-                    height: string;
-                    width: string;
-                    size: string;
-                    name: string;
-                    kind: string;
-                } & {
-                    date?: string | null | undefined;
-                }) | ({
-                    id: string;
-                    url: string;
-                    name: string;
-                    kind: string;
-                    size: string;
-                } & {
-                    date?: string | null | undefined;
-                } & {
-                    __TYPE__: "FileLink";
-                } & {
-                    size?: string;
-                }) | ({
-                    __TYPE__: "DocumentLink";
-                } & {
-                    id: string;
-                }) | ({
-                    __TYPE__: "ExternalLink";
-                } & {
-                    url: string;
-                } & {
-                    kind?: "web";
-                    target?: string | null | undefined;
-                    preview?: {
-                        title?: string;
-                    } | null | undefined;
-                }) | null | undefined;
-            };
-        } & {
-            label?: string | null | undefined;
-            direction?: string | null | undefined;
-        }) | ({
-            type: "embed";
-            data: {
-                embed_url: string;
-                type: string;
-            } & {
-                version?: string | number | null;
-                title?: string | null | undefined;
-                author_name?: string | null | undefined;
-                author_url?: string | null | undefined;
-                provider_name?: string | null | undefined;
-                provider_url?: string | null | undefined;
-                cache_age?: string | number | null;
-                thumbnail_url?: string | null | undefined;
-                thumbnail_width?: number | null | undefined;
-                thumbnail_height?: number | null | undefined;
-                html?: string | null | undefined;
-            } & {
-                __TYPE__: "EmbedContent";
-                all: unknown;
-            };
-        } & {
-            label?: string | null | undefined;
-            direction?: string | null | undefined;
-        }) | ({
-            type: "image" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
-            content: {
-                text: string;
-            } & {
-                spans?: ({
-                    data: ({
-                        __TYPE__: "ImageLink";
-                    } & {
-                        id: string;
-                        url: string;
-                        height: string;
-                        width: string;
-                        size: string;
-                        name: string;
-                        kind: string;
-                    } & {
-                        date?: string | null | undefined;
-                    }) | ({
-                        id: string;
-                        url: string;
-                        name: string;
-                        kind: string;
-                        size: string;
-                    } & {
-                        date?: string | null | undefined;
-                    } & {
-                        __TYPE__: "FileLink";
-                    } & {
-                        size?: string;
-                    }) | ({
-                        __TYPE__: "DocumentLink";
-                    } & {
-                        id: string;
-                    }) | ({
-                        __TYPE__: "ExternalLink";
-                    } & {
-                        url: string;
-                    } & {
-                        kind?: "web";
-                        target?: string | null | undefined;
-                        preview?: {
-                            title?: string;
-                        } | null | undefined;
-                    });
-                    start: number;
-                    end: number;
-                    type: "hyperlink";
-                } | {
-                    data: string;
-                    start: number;
-                    end: number;
-                    type: "label";
-                } | {
-                    start: number;
-                    end: number;
-                    type: "strong" | "em" | "list-item";
-                })[];
-            };
-        } & {
-            label?: string;
-            direction?: string;
-        }))[];
-    } | {
-        __TYPE__: "SeparatorContent";
-    }][];
-}[];

package/lib/import/converters/fields/RepeatableZone.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.repeatableZoneConverter = void 0;
-const content_1 = require("../../../content");
-const RepeatableZoneItem_1 = require("./RepeatableZoneItem");
-const repeatableZoneConverter = (zone, assets, embeds) => {
-    return zone.map((item) => {
-        const groupContent = (0, RepeatableZoneItem_1.repeatableZoneItemConverter)(item, assets, embeds);
-        return {
-            __TYPE__: content_1.GroupItemContentType,
-            value: Object.entries(groupContent),
-        };
-    });
-};
-exports.repeatableZoneConverter = repeatableZoneConverter;

package/lib/import/converters/fields/RepeatableZoneItem.d.ts

@@ -1,11 +0,0 @@
-import type { Asset, Embed } from "../../../common";
-import type { NestableContent } from "../../../content";
-import type { RepeatableZoneItem } from "../../validators";
-/**
- * Converts the RepeatableZoneItem which is a record of widget keys and ImportNestable values to a record of widget keys and NestableContent values.
- *
- * @param content a single RepeatableZoneItem
- * @param assets assets that are required for a conversion of a nestable widget
- * @param embeds embeds that are required for a conversion of a nestable widget
- */
-export declare const repeatableZoneItemConverter: (content: RepeatableZoneItem, assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>) => Record<string, NestableContent>;

package/lib/import/converters/fields/RepeatableZoneItem.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.repeatableZoneItemConverter = void 0;
-const tslib_1 = require("tslib");
-const function_1 = require("fp-ts/function");
-const O = (0, tslib_1.__importStar)(require("fp-ts/Option"));
-const R = (0, tslib_1.__importStar)(require("fp-ts/Record"));
-const nestable_1 = require("./nestable");
-/**
- * Converts the RepeatableZoneItem which is a record of widget keys and ImportNestable values to a record of widget keys and NestableContent values.
- *
- * @param content a single RepeatableZoneItem
- * @param assets assets that are required for a conversion of a nestable widget
- * @param embeds embeds that are required for a conversion of a nestable widget
- */
-const repeatableZoneItemConverter = (content, assets, embeds) => (0, function_1.pipe)(content, 
-// convertNestableWidget can theoretically return undefined, so we need to filter out those values
-R.filterMap((contentValue) => (0, function_1.pipe)(contentValue, (content) => content && (0, nestable_1.convertNestableWidget)(content, assets, embeds), O.fromNullable)));
-exports.repeatableZoneItemConverter = repeatableZoneItemConverter;

package/lib/import/converters/fields/Slices/SharedSlice.d.ts

@@ -1,4 +0,0 @@
-import type { Asset, Embed } from "../../../../common";
-import type { SliceItemContent } from "../../../../content";
-import type { SharedSlice as ImportSharedSlice } from "../../../validators/fields/ImportSlices/SharedSlice";
-export declare const sharedSliceConverter: (slice: ImportSharedSlice, assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>) => SliceItemContent;

package/lib/import/converters/fields/Slices/SharedSlice.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sharedSliceConverter = void 0;
-const uuid_1 = require("uuid");
-const SharedSliceContent_1 = require("./SharedSliceContent");
-// TODO should we put it together with SharedSliceId validator?
-const buildSharedSliceId = (slice_type) => `${slice_type}$${(0, uuid_1.v4)()}`;
-const sharedSliceConverter = (slice, assets, embeds) => {
-    var _a, _b;
-    // Right now we only support SharedSlices, if we support more types of slices in the future we'll need to select a correct converter here
-    const widget = (0, SharedSliceContent_1.importSharedSliceContentConverter)(slice, assets, embeds);
-    return {
-        key: (_a = slice.id) !== null && _a !== void 0 ? _a : buildSharedSliceId(slice.slice_type),
-        name: slice.slice_type,
-        maybeLabel: (_b = slice.slice_label) !== null && _b !== void 0 ? _b : undefined,
-        widget,
-    };
-};
-exports.sharedSliceConverter = sharedSliceConverter;

package/lib/import/converters/fields/Slices/SharedSliceContent.d.ts

@@ -1,10 +0,0 @@
-import type { Asset, Embed } from "../../../../common";
-import type { SharedSliceContent } from "../../../../content";
-import type { SharedSlice as ImportSharedSlice } from "../../../validators/fields/ImportSlices/SharedSlice";
-/**
- * Builds SharedSliceContent model from ImportSharedSlice
- * @param field ImportSharedSlice to be converted - a single slice from the slices array in the import document
- * @param assets assets that are required for a conversion of a nestable widget
- * @param embeds embeds that are required for a conversion of a nestable widget
- */
-export declare const importSharedSliceContentConverter: (field: ImportSharedSlice, assets: Record<Asset["id"], Asset | undefined>, embeds: Record<string, Embed | undefined>) => SharedSliceContent;

package/lib/import/converters/fields/Slices/SharedSliceContent.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importSharedSliceContentConverter = void 0;
-const content_1 = require("../../../../content");
-const RepeatableZone_1 = require("../RepeatableZone");
-const RepeatableZoneItem_1 = require("../RepeatableZoneItem");
-/**
- * Builds SharedSliceContent model from ImportSharedSlice
- * @param field ImportSharedSlice to be converted - a single slice from the slices array in the import document
- * @param assets assets that are required for a conversion of a nestable widget
- * @param embeds embeds that are required for a conversion of a nestable widget
- */
-const importSharedSliceContentConverter = (field, assets, embeds) => ({
-    __TYPE__: content_1.SharedSliceContentType,
-    primary: field.primary
-        ? (0, RepeatableZoneItem_1.repeatableZoneItemConverter)(field.primary, assets, embeds)
-        : {},
-    items: field.items
-        ? (0, RepeatableZone_1.repeatableZoneConverter)(field.items, assets, embeds)
-        : [],
-    variation: field.variation,
-});
-exports.importSharedSliceContentConverter = importSharedSliceContentConverter;

package/lib/import/converters/fields/Slices/Slices.d.ts

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

package/lib/import/converters/fields/Slices/Slices.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importSlicesConverter = void 0;
-const SharedSlice_1 = require("./SharedSlice");
-const importSlicesConverter = (field, assets, embeds) => {
-    if (field === null)
-        return;
-    return {
-        value: field.map((slice) => {
-            // Right now we only support SharedSlices, if we support more types of slices in the future we'll need to select a correct converter here
-            return (0, SharedSlice_1.sharedSliceConverter)(slice, assets, embeds);
-        }),
-        __TYPE__: "SliceContentType",
-    };
-};
-exports.importSlicesConverter = importSlicesConverter;

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

@@ -1 +0,0 @@
-export * from "./Slices";

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

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

package/lib/import/converters/fields/UID.d.ts

@@ -1,3 +0,0 @@
-import type { UIDContent } from "../../../content";
-import type { ImportUID } from "../../validators/fields/UID";
-export declare const uidConverter: (field: ImportUID["value"]) => UIDContent;

package/lib/import/converters/fields/UID.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uidConverter = void 0;
-const uidConverter = (field) => {
-    return {
-        value: field,
-        __TYPE__: "UIDContent",
-    };
-};
-exports.uidConverter = uidConverter;

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

@@ -1,4 +0,0 @@
-export * from "./Group";
-export * from "./nestable";
-export * from "./Slices";
-export * from "./UID";

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

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./Group"), exports);
-(0, tslib_1.__exportStar)(require("./nestable"), exports);
-(0, tslib_1.__exportStar)(require("./Slices"), exports);
-(0, tslib_1.__exportStar)(require("./UID"), exports);

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

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

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

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.booleanConverter = void 0;
-const booleanConverter = (field) => {
-    if (field === null)
-        return;
-    return {
-        value: field,
-        __TYPE__: "BooleanContent",
-    };
-};
-exports.booleanConverter = booleanConverter;

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

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

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

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

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

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

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

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dateConverter = void 0;
-const dateConverter = (field) => {
-    if (field === null)
-        return;
-    const isoDate = field.toISOString();
-    const [withoutTime] = isoDate.split("T");
-    return {
-        type: "Date",
-        value: withoutTime || isoDate,
-        __TYPE__: "FieldContent",
-    };
-};
-exports.dateConverter = dateConverter;

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

@@ -1,4 +0,0 @@
-import type { Embed } from "../../../../common";
-import type { EmbedContent } from "../../../../content";
-import type { ImportEmbed } from "../../../validators";
-export declare const embedConverter: (field: ImportEmbed["value"], embeds: Record<string, Embed | undefined>) => EmbedContent | undefined;