@prismicio/types-internal 3.16.1 → 3.16.2-alpha.1

package/lib/content/Document.d.ts

@@ -3,7 +3,7 @@ import { WidgetKey } from "../common";
 import { type StaticWidget, StaticCustomType } from "../customtypes";
 import { WidgetContent } from "./fields";
 import { FieldOrSliceType, WithTypes } from "./LegacyContentCtx";
-import { ContentPath, TraverseSliceContentFn, TraverseWidgetContentFn } from "./utils";
+import { ContentPath, TraverseSliceContentFn, TraverseSliceContentWithModelFn, TraverseWidgetContentFn, TraverseWidgetContentWithModelFn } from "./utils";
 export declare const Document: t.RecordC<t.Type<string, string, unknown>, t.UnionC<[t.Type<import("./fields").GroupContent, import("./fields").GroupContent, unknown>, t.UnionC<[t.ExactC<t.TypeC<{
     type: t.StringC;
     __TYPE__: t.LiteralC<"EmptyContent">;
@@ -11800,4 +11800,14 @@ export declare function migrateDocument(document: Document, customType: StaticCu
         }[];
     };
 };
+export declare function traverseDocumentWithModel({ document, customType, }: {
+    document: Document;
+    customType: StaticCustomType | {
+        customTypeId: string;
+        fields: Record<string, StaticWidget>;
+    };
+}): ({ transformWidget, transformSlice, }: {
+    transformWidget: TraverseWidgetContentWithModelFn;
+    transformSlice: TraverseSliceContentWithModelFn;
+}) => Document;
 export {};

package/lib/content/Document.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrateDocument = exports.collectWidgets = exports.traverseDocument = exports.fillDocumentWithDefaultValues = exports.DocumentLegacy = exports.Document = void 0;
+exports.traverseDocumentWithModel = exports.migrateDocument = exports.collectWidgets = exports.traverseDocument = exports.fillDocumentWithDefaultValues = exports.DocumentLegacy = exports.Document = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const Either_1 = require("fp-ts/lib/Either");
@@ -264,3 +264,101 @@ function migrateDocument(document, customType) {
     });
 }
 exports.migrateDocument = migrateDocument;
+function traverseDocumentWithModel({ document, customType, }) {
+    const model = customtypes_1.StaticCustomType.is(customType)
+        ? simplifyCustomType(customType)
+        : customType;
+    return ({ transformWidget, transformSlice, }) => {
+        return Object.entries(model.fields).reduce((acc, [key, fieldModel]) => {
+            const content = document[key];
+            const path = utils_1.ContentPath.make([
+                { key: model.customTypeId, type: "CustomType" },
+                { key, type: "Widget" },
+            ]);
+            const transformedWidget = (() => {
+                var _a;
+                switch (fieldModel.type) {
+                    case "Choice":
+                    case "Slices": {
+                        const slicesContent = (0, fields_1.isSlicesContent)(content)
+                            ? content
+                            : undefined;
+                        return (0, fields_1.traverseSlicesWithModel)({
+                            path,
+                            key,
+                            model: fieldModel,
+                            content: slicesContent,
+                        })({ transformWidget, transformSlice });
+                    }
+                    case "Group": {
+                        const groupContent = (0, fields_1.isGroupContent)(content) ? content : undefined;
+                        return (0, fields_1.traverseGroupContentWithModel)({
+                            path,
+                            key,
+                            model: fieldModel,
+                            content: groupContent,
+                        })(transformWidget);
+                    }
+                    case "Link": {
+                        if (((_a = fieldModel.config) === null || _a === void 0 ? void 0 : _a.repeat) === true) {
+                            const repeatableContent = (0, fields_1.isRepeatableContent)(content)
+                                ? content
+                                : undefined;
+                            return (0, fields_1.traverseRepeatableContentWithModel)({
+                                path,
+                                key,
+                                model: fieldModel,
+                                content: repeatableContent,
+                            })(transformWidget);
+                        }
+                        const nestableContent = (0, fields_1.isNestableContent)(content)
+                            ? content
+                            : undefined;
+                        return transformWidget({
+                            path,
+                            key,
+                            apiId: key,
+                            model: fieldModel,
+                            content: nestableContent,
+                        });
+                    }
+                    case "Table": {
+                        const tableContent = (0, fields_1.isTableContent)(content) ? content : undefined;
+                        return (0, fields_1.traverseTableContentWithModel)({
+                            path,
+                            key,
+                            model: fieldModel,
+                            content: tableContent,
+                        })(transformWidget);
+                    }
+                    case "UID": {
+                        return transformWidget({
+                            path,
+                            key,
+                            apiId: key,
+                            model: fieldModel,
+                            content,
+                        });
+                    }
+                    default: {
+                        const nestableContent = (0, fields_1.isNestableContent)(content)
+                            ? content
+                            : undefined;
+                        return transformWidget({
+                            path,
+                            key,
+                            apiId: key,
+                            model: fieldModel,
+                            content: nestableContent,
+                        });
+                    }
+                }
+            })();
+            return {
+                ...acc,
+                ...(transformedWidget ? { [key]: transformedWidget } : {}),
+            };
+        }, {});
+    };
+}
+exports.traverseDocumentWithModel = traverseDocumentWithModel;

package/lib/content/fields/GroupContent.d.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
-import { type Group, type NestableWidget } from "../../customtypes";
+import { type Group, type NestableWidget, type NestedGroup } from "../../customtypes";
 import { LegacyContentCtx, WithTypes } from "../LegacyContentCtx";
-import { ContentPath, TraverseWidgetContentFn } from "../utils";
+import { ContentPath, TraverseWidgetContentFn, TraverseWidgetContentWithModelFn } from "../utils";
 import { NestableContent } from "./nestable";
 export declare const GroupItemContentType: "GroupItemContent";
 export declare const GroupContentType: "GroupContentType";
@@ -39,4 +39,15 @@ export declare function traverseGroupItemsContent({ path, model, content, }: {
     content: Array<GroupItemContent>;
     model?: Record<string, Group | NestableWidget> | undefined;
 }): (transform: TraverseWidgetContentFn) => Array<GroupItemContent>;
+export declare function traverseGroupContentWithModel({ path, key, model, content, }: {
+    path: ContentPath;
+    key: string;
+    model: Group;
+    content: GroupContent | undefined;
+}): (transform: TraverseWidgetContentWithModelFn) => GroupContent | undefined;
+export declare function traverseGroupItemsContentWithModel({ path, model, content, }: {
+    path: ContentPath;
+    model: Record<string, NestableWidget | Group | NestedGroup>;
+    content: Array<GroupItemContent> | undefined;
+}): (transform: TraverseWidgetContentWithModelFn) => Array<GroupItemContent>;
 export {};

package/lib/content/fields/GroupContent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.traverseGroupItemsContent = exports.traverseGroupContent = exports.groupContentWithDefaultValues = exports.GroupLegacy = exports.arrayWithIndexCodec = exports.GroupItemLegacy = exports.GroupContentDefaultValue = exports.isGroupContent = exports.GroupContent = exports.GroupItemContent = exports.GroupContentType = exports.GroupItemContentType = void 0;
+exports.traverseGroupItemsContentWithModel = exports.traverseGroupContentWithModel = exports.traverseGroupItemsContent = exports.traverseGroupContent = exports.groupContentWithDefaultValues = exports.GroupLegacy = exports.arrayWithIndexCodec = exports.GroupItemLegacy = exports.GroupContentDefaultValue = exports.isGroupContent = exports.GroupContent = exports.GroupItemContent = exports.GroupContentType = exports.GroupItemContentType = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const Either_1 = require("fp-ts/lib/Either");
@@ -206,3 +206,102 @@ function traverseGroupItemsContent({ path, model, content, }) {
     };
 }
 exports.traverseGroupItemsContent = traverseGroupItemsContent;
+function traverseGroupContentWithModel({ path, key, model, content, }) {
+    return (transform) => {
+        var _a, _b;
+        const groupItems = traverseGroupItemsContentWithModel({
+            path,
+            model: (_b = (_a = model.config) === null || _a === void 0 ? void 0 : _a.fields) !== null && _b !== void 0 ? _b : {},
+            content: content === null || content === void 0 ? void 0 : content.value,
+        })(transform);
+        return transform({
+            path,
+            key,
+            apiId: key,
+            model,
+            content: content
+                ? {
+                    __TYPE__: content.__TYPE__,
+                    value: groupItems,
+                }
+                : undefined,
+        });
+    };
+}
+exports.traverseGroupContentWithModel = traverseGroupContentWithModel;
+function traverseGroupItemsContentWithModel({ path, model, content, }) {
+    return (transform) => {
+        if (!content)
+            return [];
+        return content.map((groupItem) => {
+            const groupItemPath = path.concat([
+                { key: groupItem.key, type: "GroupItem" },
+            ]);
+            const groupItemFields = Object.entries(model).reduce((acc, [fieldKey, fieldModel]) => {
+                var _a, _b;
+                const fieldContent = (_a = groupItem.value.find(([key]) => key === fieldKey)) === null || _a === void 0 ? void 0 : _a[1];
+                const fieldPath = groupItemPath.concat([
+                    { key: fieldKey, type: "Widget" },
+                ]);
+                let transformedField;
+                if (fieldModel.type === "Group") {
+                    const groupContent = (0, exports.isGroupContent)(fieldContent)
+                        ? fieldContent
+                        : undefined;
+                    transformedField = traverseGroupContentWithModel({
+                        path: fieldPath,
+                        key: fieldKey,
+                        model: fieldModel,
+                        content: groupContent,
+                    })(transform);
+                }
+                else if (fieldModel.type === "Link" &&
+                    ((_b = fieldModel.config) === null || _b === void 0 ? void 0 : _b.repeat) === true) {
+                    const repeatableContent = (0, nestable_1.isRepeatableContent)(fieldContent)
+                        ? fieldContent
+                        : undefined;
+                    transformedField = (0, nestable_1.traverseRepeatableContentWithModel)({
+                        path: fieldPath,
+                        key: fieldKey,
+                        model: fieldModel,
+                        content: repeatableContent,
+                    })(transform);
+                }
+                else if (fieldModel.type === "Table") {
+                    const tableContent = (0, nestable_1.isTableContent)(fieldContent)
+                        ? fieldContent
+                        : undefined;
+                    transformedField = (0, nestable_1.traverseTableContentWithModel)({
+                        path: fieldPath,
+                        key: fieldKey,
+                        model: fieldModel,
+                        content: tableContent,
+                    })(transform);
+                }
+                else {
+                    const nestableContent = (0, nestable_1.isNestableContent)(fieldContent)
+                        ? fieldContent
+                        : undefined;
+                    transformedField = transform({
+                        path: fieldPath,
+                        key: fieldKey,
+                        apiId: fieldKey,
+                        model: fieldModel,
+                        content: nestableContent,
+                    });
+                }
+                if (!transformedField ||
+                    !((0, nestable_1.isNestableContent)(transformedField) ||
+                        (0, exports.isGroupContent)(transformedField)))
+                    return acc;
+                return acc.concat([[fieldKey, transformedField]]);
+            }, []);
+            return {
+                __TYPE__: groupItem.__TYPE__,
+                key: groupItem.key,
+                value: groupItemFields,
+            };
+        });
+    };
+}
+exports.traverseGroupItemsContentWithModel = traverseGroupItemsContentWithModel;

package/lib/content/fields/nestable/RepeatableContent.d.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import type { Link, NestableWidget } from "../../../customtypes";
 import type { LegacyContentCtx, WithTypes } from "../../LegacyContentCtx";
-import { ContentPath, TraverseWidgetContentFn } from "../../utils";
+import { ContentPath, TraverseWidgetContentFn, TraverseWidgetContentWithModelFn } from "../../utils";
 export declare const RepeatableContent: t.ExactC<t.TypeC<{
     __TYPE__: t.LiteralC<"RepeatableContent">;
     type: t.LiteralC<"Link">;
@@ -174,3 +174,9 @@ export declare function traverseRepeatableContent({ path, key, apiId, model, con
     content: RepeatableContent;
     model?: NestableWidget | undefined;
 }): (transform: TraverseWidgetContentFn) => RepeatableContent | undefined;
+export declare function traverseRepeatableContentWithModel({ path, key, model, content, }: {
+    path: ContentPath;
+    key: string;
+    model: NestableWidget;
+    content: RepeatableContent | undefined;
+}): (transform: TraverseWidgetContentWithModelFn) => RepeatableContent | undefined;

package/lib/content/fields/nestable/RepeatableContent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.traverseRepeatableContent = exports.RepeatableLegacy = exports.isRepeatableContent = exports.RepeatableContent = void 0;
+exports.traverseRepeatableContentWithModel = exports.traverseRepeatableContent = exports.RepeatableLegacy = exports.isRepeatableContent = exports.RepeatableContent = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const Either_1 = require("fp-ts/lib/Either");
@@ -102,3 +102,45 @@ function traverseRepeatableContent({ path, key, apiId, model, content, }) {
     };
 }
 exports.traverseRepeatableContent = traverseRepeatableContent;
+function traverseRepeatableContentWithModel({ path, key, model, content, }) {
+    return (transform) => {
+        var _a;
+        const items = (_a = content === null || content === void 0 ? void 0 : content.value.reduce((acc, fieldContent, index) => {
+            const itemPath = path.concat([
+                { key: index.toString(), type: "Widget" },
+            ]);
+            const newModel = (model === null || model === void 0 ? void 0 : model.type) === "Link" && model.config
+                ? {
+                    ...model,
+                    config: { ...model.config, repeat: false },
+                }
+                : model;
+            const transformedField = transform({
+                path: itemPath,
+                key: key,
+                apiId: key,
+                model: newModel,
+                content: fieldContent,
+            });
+            if (!transformedField)
+                return acc;
+            if (!(0, LinkContent_1.isLinkContent)(transformedField))
+                return acc;
+            return acc.concat(transformedField);
+        }, [])) !== null && _a !== void 0 ? _a : [];
+        return transform({
+            path,
+            key,
+            apiId: key,
+            model,
+            content: content
+                ? {
+                    __TYPE__: content.__TYPE__,
+                    type: content.type,
+                    value: items,
+                }
+                : undefined,
+        });
+    };
+}
+exports.traverseRepeatableContentWithModel = traverseRepeatableContentWithModel;

package/lib/content/fields/nestable/TableContent.d.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { type NestableWidget } from "../../../customtypes";
 import type { LegacyContentCtx, WithTypes } from "../../LegacyContentCtx";
-import { ContentPath, TraverseWidgetContentFn } from "../../utils";
+import { ContentPath, TraverseWidgetContentFn, TraverseWidgetContentWithModelFn } from "../../utils";
 export declare const TableContentType = "TableContent";
 export declare const isTableContent: (u: unknown) => u is {
     __TYPE__: "TableContent";
@@ -768,3 +768,9 @@ export declare function traverseTableContent({ path, key, apiId, model, content,
     content: TableContent;
     model?: NestableWidget | undefined;
 }): (transform: TraverseWidgetContentFn) => TableContent | undefined;
+export declare function traverseTableContentWithModel({ path, key, model, content, }: {
+    path: ContentPath;
+    key: string;
+    model: NestableWidget;
+    content: TableContent | undefined;
+}): (transform: TraverseWidgetContentWithModelFn) => TableContent | undefined;

package/lib/content/fields/nestable/TableContent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.traverseTableContent = exports.TableLegacy = exports.TableContent = exports.isTableContent = exports.TableContentType = void 0;
+exports.traverseTableContentWithModel = exports.traverseTableContent = exports.TableLegacy = exports.TableContent = exports.isTableContent = exports.TableContentType = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const function_1 = require("fp-ts/lib/function");
@@ -119,3 +119,49 @@ function traverseTableContent({ path, key, apiId, model, content, }) {
     };
 }
 exports.traverseTableContent = traverseTableContent;
+function traverseTableContentWithModel({ path, key, model, content, }) {
+    return (transform) => {
+        var _a;
+        const tableContent = (_a = content === null || content === void 0 ? void 0 : content.content.map((row, rowIndex) => ({
+            ...row,
+            content: row.content.map((cell, cellIndex) => {
+                const itemPath = path.concat([
+                    {
+                        key: [rowIndex.toString(), cellIndex.toString()].join(","),
+                        type: "Widget",
+                    },
+                ]);
+                const cellContent = transform({
+                    path: itemPath,
+                    key,
+                    apiId: key,
+                    model: customtypes_1.TableCell,
+                    content: {
+                        __TYPE__: cell.content.__TYPE__,
+                        value: cell.content.value,
+                    },
+                }) || {
+                    __TYPE__: "StructuredTextContent",
+                    value: [],
+                };
+                return {
+                    ...cell,
+                    content: cellContent,
+                };
+            }),
+        }))) !== null && _a !== void 0 ? _a : [];
+        return transform({
+            path,
+            key,
+            apiId: key,
+            model,
+            content: content
+                ? {
+                    __TYPE__: content.__TYPE__,
+                    content: tableContent,
+                }
+                : undefined,
+        });
+    };
+}
+exports.traverseTableContentWithModel = traverseTableContentWithModel;

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { type StaticSlices } from "../../../customtypes";
 import type { LegacyContentCtx, WithTypes } from "../../LegacyContentCtx";
-import { ContentPath, TraverseSliceContentFn, TraverseWidgetContentFn } from "../../utils";
+import { ContentPath, TraverseSliceContentFn, TraverseSliceContentWithModelFn, TraverseWidgetContentFn, TraverseWidgetContentWithModelFn } from "../../utils";
 export declare const SlicesContentType = "SliceContentType";
 export declare const isSlicesContent: (u: unknown) => u is {
     __TYPE__: "SliceContentType";
@@ -598,7 +598,7 @@ export declare const isSlicesContent: (u: unknown) => u is {
                     variant?: string;
                 });
             })[];
-        } | import("..").GroupContent | {
+        } | import("../GroupContent").GroupContent | {
             __TYPE__: "CompositeSliceContent";
             nonRepeat: {
                 [x: string]: {
@@ -1784,7 +1784,7 @@ export declare const isSlicesContent: (u: unknown) => u is {
                             variant?: string;
                         });
                     })[];
-                } | import("..").GroupContent][];
+                } | import("../GroupContent").GroupContent][];
             }[];
         } | {
             __TYPE__: "SharedSliceContent";
@@ -2379,7 +2379,7 @@ export declare const isSlicesContent: (u: unknown) => u is {
                             variant?: string;
                         });
                     })[];
-                } | import("..").GroupContent;
+                } | import("../GroupContent").GroupContent;
             };
             items: {
                 __TYPE__: "GroupItemContent";
@@ -2973,7 +2973,7 @@ export declare const isSlicesContent: (u: unknown) => u is {
                             variant?: string;
                         });
                     })[];
-                } | import("..").GroupContent][];
+                } | import("../GroupContent").GroupContent][];
             }[];
         };
     }[];
@@ -3574,7 +3574,7 @@ export declare const SlicesLegacy: (ctx: LegacyContentCtx) => t.Type<{
                     variant?: string;
                 });
             })[];
-        } | import("..").GroupContent | {
+        } | import("../GroupContent").GroupContent | {
             __TYPE__: "CompositeSliceContent";
             nonRepeat: {
                 [x: string]: {
@@ -4760,7 +4760,7 @@ export declare const SlicesLegacy: (ctx: LegacyContentCtx) => t.Type<{
                             variant?: string;
                         });
                     })[];
-                } | import("..").GroupContent][];
+                } | import("../GroupContent").GroupContent][];
             }[];
         } | {
             __TYPE__: "SharedSliceContent";
@@ -5355,7 +5355,7 @@ export declare const SlicesLegacy: (ctx: LegacyContentCtx) => t.Type<{
                             variant?: string;
                         });
                     })[];
-                } | import("..").GroupContent;
+                } | import("../GroupContent").GroupContent;
             };
             items: {
                 __TYPE__: "GroupItemContent";
@@ -5949,7 +5949,7 @@ export declare const SlicesLegacy: (ctx: LegacyContentCtx) => t.Type<{
                             variant?: string;
                         });
                     })[];
-                } | import("..").GroupContent][];
+                } | import("../GroupContent").GroupContent][];
             }[];
         };
     }[];
@@ -7492,7 +7492,7 @@ export declare const SlicesContent: t.TypeC<{
                             variant: t.StringC;
                         }>]>>]>]>;
                     }>>]>>;
-                }>>]>, t.Type<import("..").GroupContent, import("..").GroupContent, unknown>]>]>>;
+                }>>]>, t.Type<import("../GroupContent").GroupContent, import("../GroupContent").GroupContent, unknown>]>]>>;
             }>>>;
         }>>, t.ExactC<t.TypeC<{
             __TYPE__: t.LiteralC<"SharedSliceContent">;
@@ -8260,7 +8260,7 @@ export declare const SlicesContent: t.TypeC<{
                         variant: t.StringC;
                     }>]>>]>]>;
                 }>>]>>;
-            }>>]>, t.Type<import("..").GroupContent, import("..").GroupContent, unknown>]>>;
+            }>>]>, t.Type<import("../GroupContent").GroupContent, import("../GroupContent").GroupContent, unknown>]>>;
             items: t.ArrayC<t.ExactC<t.TypeC<{
                 __TYPE__: t.LiteralC<"GroupItemContent">;
                 key: t.StringC;
@@ -9027,7 +9027,7 @@ export declare const SlicesContent: t.TypeC<{
                             variant: t.StringC;
                         }>]>>]>]>;
                     }>>]>>;
-                }>>]>, t.Type<import("..").GroupContent, import("..").GroupContent, unknown>]>]>>;
+                }>>]>, t.Type<import("../GroupContent").GroupContent, import("../GroupContent").GroupContent, unknown>]>]>>;
             }>>>;
         }>>, t.UnionC<[t.UnionC<[t.ExactC<t.TypeC<{
             type: t.StringC;
@@ -9792,7 +9792,7 @@ export declare const SlicesContent: t.TypeC<{
                     variant: t.StringC;
                 }>]>>]>]>;
             }>>]>>;
-        }>>]>, t.Type<import("..").GroupContent, import("..").GroupContent, unknown>]>]>;
+        }>>]>, t.Type<import("../GroupContent").GroupContent, import("../GroupContent").GroupContent, unknown>]>]>;
     }>>;
 }>;
 export declare type SlicesContent = t.TypeOf<typeof SlicesContent>;
@@ -9806,4 +9806,13 @@ export declare function traverseSlices({ path, key, model, content, }: {
     transformWidget?: TraverseWidgetContentFn;
     transformSlice?: TraverseSliceContentFn;
 }) => SlicesContent | undefined;
+export declare function traverseSlicesWithModel({ path, key, model, content, }: {
+    path: ContentPath;
+    key: string;
+    model: StaticSlices;
+    content: SlicesContent | undefined;
+}): (args: {
+    transformWidget: TraverseWidgetContentWithModelFn;
+    transformSlice: TraverseSliceContentWithModelFn;
+}) => SlicesContent | undefined;
 export {};