@prismicio/types-internal 2.2.0-alpha.25 → 2.2.0-alpha.26

package/lib/import/converters/Document.js

@@ -13,6 +13,8 @@ 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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,14 @@
+"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

@@ -0,0 +1,309 @@
+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: "image" | "label" | "paragraph" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "strong" | "em" | "preformatted" | "hyperlink" | "embed" | "list-item" | "o-list-item" | "rtl";
+                })[];
+            };
+        } & {
+            label?: string;
+            direction?: string;
+        }))[];
+    } | {
+        __TYPE__: "SeparatorContent";
+    }][];
+}[];

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

@@ -0,0 +1,15 @@
+"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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,19 @@
+"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/SharedSliceContent.js

@@ -1,46 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.importSharedSliceContentConverter = 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 content_1 = require("../../../../content");
-const nestable_1 = require("../nestable");
-/**
- * Converts the ImportSharedSliceContent which is a record of widget keys and ImportNestable values to a record of widget keys and NestableContent values.
- *
- * @param content a single ImportSharedSliceContent
- * @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 sharedSliceContentConverter = (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) => (0, nestable_1.convertNestableWidget)(content, assets, embeds), O.fromNullable)));
-/**
- * Converts a list of items to a list of repeatable widgets.
- * Each ImportSharedSliceContent element is a record of fields, but in the content model it is represented as a list of tuples (key, value)
- *
- * For example, given the following slice content:
- *  {
- *  	"slice_text": (ImportNestable),
- *  	"slice_number": (ImportNestable),
- *  }
- *
- *  has to be converted to:
- *
- *  {
- *      __TYPE__: "GroupItemContentType",
- *      value: [
- *      	["slice_text", (NestableContent)],
- *      	["slice_number", (NestableContent)],
- *      ]
- *  }
- *
- *  @param items list of items to be converted
- *  @param assets assets that are required for a conversion of a nestable widget
- */
-const itemsConverter = (items, assets, embeds) => items.map((item) => (0, function_1.pipe)(sharedSliceContentConverter(item, assets, embeds), (record) => Object.entries(record), (entries) => ({ __TYPE__: content_1.GroupItemContentType, value: entries })));
+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
@@ -50,9 +13,11 @@ const itemsConverter = (items, assets, embeds) => items.map((item) => (0, functi
 const importSharedSliceContentConverter = (field, assets, embeds) => ({
     __TYPE__: content_1.SharedSliceContentType,
     primary: field.primary
-        ? sharedSliceContentConverter(field.primary, assets, embeds)
+        ? (0, RepeatableZoneItem_1.repeatableZoneItemConverter)(field.primary, assets, embeds)
         : {},
-    items: field.items ? itemsConverter(field.items, assets, embeds) : [],
+    items: field.items
+        ? (0, RepeatableZone_1.repeatableZoneConverter)(field.items, assets, embeds)
+        : [],
     variation: field.variation,
 });
 exports.importSharedSliceContentConverter = importSharedSliceContentConverter;

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

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

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

@@ -1,6 +1,7 @@
 "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/validators/fields/ImportField.d.ts

@@ -1,7 +1,8 @@
 import type { StaticWidget } from "../../../customtypes";
+import { ImportGroup } from "./ImportGroup";
 import { ImportSlices } from "./ImportSlices";
 import { ImportNestable } from "./nestable";
-export declare type ImportField = ImportSlices | ImportNestable;
+export declare type ImportField = ImportSlices | ImportNestable | ImportGroup;
 export declare const ImportField: {
     is(u: unknown): u is ImportField;
     decode: (field: StaticWidget) => (content: unknown) => {
@@ -127,5 +128,14 @@ export declare const ImportField: {
             type: "Slices";
             value: import("./ImportSlices/SharedSlice").SharedSlice[] | null;
         }>;
+    } | {
+        codec: import("io-ts").Type<{
+            type: "Group";
+            value: import("./RepeatableZoneItem").RepeatableZoneItem[] | null;
+        }, import("./RepeatableZoneItem").RepeatableZoneItem[] | undefined, unknown>;
+        result: import("io-ts").Validation<{
+            type: "Group";
+            value: import("./RepeatableZoneItem").RepeatableZoneItem[] | null;
+        }>;
     };
 };

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImportField = void 0;
+const ImportGroup_1 = require("./ImportGroup");
 const ImportSlices_1 = require("./ImportSlices");
 const nestable_1 = require("./nestable");
 exports.ImportField = {
@@ -17,8 +18,12 @@ exports.ImportField = {
                         codec: (0, ImportSlices_1.ImportSlices)(field),
                         result: (0, ImportSlices_1.ImportSlices)(field).decode(content),
                     };
-                case "Choice":
                 case "Group":
+                    return {
+                        codec: (0, ImportGroup_1.ImportGroup)(field),
+                        result: (0, ImportGroup_1.ImportGroup)(field).decode(content),
+                    };
+                case "Choice":
                     throw new Error(`Unsupported type of field ${field.type}`);
                 default:
                     return nestable_1.ImportNestable.decode(field)(content);