@prismicio/types-internal 2.2.0-alpha.9 → 2.2.0-traverse.alpha-0

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportImage = void 0;
+const tslib_1 = require("tslib");
+const Either_1 = require("fp-ts/Either");
+const function_1 = require("fp-ts/function");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const validators_1 = require("../../../../../validators");
+const function_2 = require("../../../../../validators/function");
+const ImportContent_1 = require("../../ImportContent");
+const Decoder_1 = require("./Decoder");
+const Validator_1 = require("./Validator");
+const defaultImage = (field) => {
+    var _a;
+    // If there is not thumbnails we expect an empty object
+    if (!((_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.thumbnails) || !field.config.thumbnails.length)
+        return validators_1.EmptyObject;
+    // If there are thumbnails, we expect an object with thumbnails as empty objects
+    return (0, function_2.withCustomError)(t.strict(field.config.thumbnails.reduce((acc, thumbnail) => ({
+        ...acc,
+        [thumbnail.name]: validators_1.EmptyObject,
+    }), {})), () => "The value must be an object");
+};
+const ImageField = (field) => new t.Type("ImageField", (u) => Validator_1.ImageFieldValidator.is(u) &&
+    "thumbnails" in u &&
+    Validator_1.ThumbnailsValidator.is(u["thumbnails"]), (u, ctx) => {
+    return (0, function_1.pipe)(Validator_1.ImageFieldValidator.validate(u, ctx), (0, Either_1.chain)((mainImage) => {
+        const { id, dimensions, edit, copyright, alt, ...maybeThumbnails } = mainImage;
+        return (0, function_1.pipe)(Validator_1.ThumbnailsValidator.validate(maybeThumbnails, ctx), (0, Either_1.map)((thumbnails) => {
+            var _a;
+            return ({
+                ...(0, Decoder_1.decodeImageField)(mainImage, mainImage, (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.constraint),
+                thumbnails: (0, Decoder_1.decodeThumbnails)(mainImage, thumbnails, field),
+            });
+        }));
+    }));
+}, t.identity);
+const ImageCodec = (field) => (0, function_2.withCustomError)((0, validators_1.DefaultOrElse)(defaultImage(field))(ImageField(field)), () => "An image field must be an object");
+const ImportImage = (field) => (0, ImportContent_1.ImportContent)("Image", ImageCodec(field));
+exports.ImportImage = ImportImage;
+(0, tslib_1.__exportStar)(require("./model"), exports);

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

@@ -0,0 +1,18 @@
+export declare type ImageField = {
+    id: string;
+    edit: {
+        x: number;
+        y: number;
+        zoom: number;
+        background?: string;
+    };
+    dimensions: {
+        width?: number;
+        height?: number;
+    };
+    copyright?: string | null;
+    alt?: string | null;
+};
+export declare type ImageFieldWithThumbnails = ImageField & {
+    thumbnails: Record<string, ImageField>;
+};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImportLink = void 0;
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
-const io_ts_types_1 = require("io-ts-types");
 const DocumentId_1 = require("../../../../utils/DocumentId");
 const validators_1 = require("../../../../validators");
+const function_1 = require("../../../../validators/function");
 const ImportContent_1 = require("../ImportContent");
 const LinkTypeValidator = t.type({
-    link_type: (0, io_ts_types_1.withMessage)(t.union([t.literal("Web"), t.literal("Document"), t.literal("Media")]), () => "The value must be `Web`, `Document` or `Media`"),
+    link_type: (0, function_1.withCustomError)(t.union([t.literal("Web"), t.literal("Document"), t.literal("Media")]), () => "The value must be `Web`, `Document` or `Media`"),
 });
 const WebLink = t.intersection([
     t.type({

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

@@ -25,42 +25,12 @@ export declare const ImportNestable: {
             value: Date | null;
         }, Date | undefined, unknown> | import("io-ts").Type<{
             type: "Embed";
-            value: ({
+            value: {
                 embed_url: string;
-                type: string;
-            } & {
-                version?: string | number | null;
-                title?: string;
-                author_name?: string | null;
-                author_url?: string | null;
-                provider_name?: string | null;
-                provider_url?: string | null;
-                cache_age?: string | number | null;
-                thumbnail_url?: string | null;
-                thumbnail_width?: number | null;
-                thumbnail_height?: number | null;
-                html?: string | null;
-            } & {
-                all: unknown;
-            }) | null;
-        }, ({
+            } | null;
+        }, {
             embed_url: string;
-            type: string;
-        } & {
-            version?: string | number | null;
-            title?: string;
-            author_name?: string | null;
-            author_url?: string | null;
-            provider_name?: string | null;
-            provider_url?: string | null;
-            cache_age?: string | number | null;
-            thumbnail_url?: string | null;
-            thumbnail_width?: number | null;
-            thumbnail_height?: number | null;
-            html?: string | null;
-        } & {
-            all: unknown;
-        }) | undefined, unknown> | import("io-ts").Type<{
+        } | undefined, unknown> | import("io-ts").Type<{
             type: "GeoPoint";
             value: {
                 latitude: number;
@@ -71,12 +41,8 @@ export declare const ImportNestable: {
             longitude: number;
         } | undefined, unknown> | import("io-ts").Type<{
             type: "Image";
-            value: (import("./Image").ImageField & {
-                thumbnails: Record<string, import("./Image").ImageField>;
-            }) | null;
-        }, (import("./Image").ImageField & {
-            thumbnails: Record<string, import("./Image").ImageField>;
-        }) | undefined, unknown> | import("io-ts").Type<{
+            value: import("./Image").ImageFieldWithThumbnails | null;
+        }, import("./Image").ImageFieldWithThumbnails | undefined, unknown> | import("io-ts").Type<{
             type: "Link";
             value: ({
                 link_type: "Web";
@@ -133,9 +99,7 @@ export declare const ImportNestable: {
             } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Image";
-            value: (import("./Image").ImageField & {
-                thumbnails: Record<string, import("./Image").ImageField>;
-            }) | null;
+            value: import("./Image").ImageFieldWithThumbnails | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "GeoPoint";
             value: {
@@ -144,24 +108,9 @@ export declare const ImportNestable: {
             } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Embed";
-            value: ({
+            value: {
                 embed_url: string;
-                type: string;
-            } & {
-                version?: string | number | null;
-                title?: string;
-                author_name?: string | null;
-                author_url?: string | null;
-                provider_name?: string | null;
-                provider_url?: string | null;
-                cache_age?: string | number | null;
-                thumbnail_url?: string | null;
-                thumbnail_width?: number | null;
-                thumbnail_height?: number | null;
-                html?: string | null;
-            } & {
-                all: unknown;
-            }) | null;
+            } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Date";
             value: Date | null;

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

@@ -4,6 +4,7 @@ export * from "./Date";
 export * from "./Embed";
 export * from "./GeoPoint";
 export * from "./Image";
+export * from "./Image/index";
 export * from "./Link";
 export * from "./Nestable";
 export * from "./Number";

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

@@ -7,6 +7,7 @@ const tslib_1 = require("tslib");
 (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("./Image/index"), exports);
 (0, tslib_1.__exportStar)(require("./Link"), exports);
 (0, tslib_1.__exportStar)(require("./Nestable"), exports);
 (0, tslib_1.__exportStar)(require("./Number"), exports);

package/lib/utils/DocumentId.d.ts

@@ -1 +1,2 @@
-export declare const DocumentId: import("io-ts").Type<string, string, unknown>;
+import * as t from "io-ts";
+export declare const DocumentId: t.Type<string, string, unknown>;

package/lib/utils/DocumentId.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentId = void 0;
-const io_ts_types_1 = require("io-ts-types");
-const validators_1 = require("../validators");
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
 const function_1 = require("../validators/function");
-exports.DocumentId = (0, io_ts_types_1.withMessage)((0, function_1.refineType)(validators_1.String, "DocumentId", (s) => s.length === 16), () => "DocumentId must be a 16 character string");
+exports.DocumentId = (0, function_1.withCustomError)((0, function_1.refineType)(t.string, "DocumentId", (s) => s.length === 16), () => "DocumentId must be a 16 character string");

package/lib/utils/io-ts.d.ts

@@ -0,0 +1,2 @@
+import type { Validation } from "io-ts";
+export declare const combineValidationResults: <T>(validationResults: readonly Validation<T>[]) => Validation<readonly T[]>;

package/lib/utils/io-ts.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.combineValidationResults = void 0;
+const tslib_1 = require("tslib");
+const E = (0, tslib_1.__importStar)(require("fp-ts/Either"));
+const function_1 = require("fp-ts/function");
+const RA = (0, tslib_1.__importStar)(require("fp-ts/ReadonlyArray"));
+/*
+ * Semigroup simply defines how to concatenate two values of the same type.
+ * In this instance, Errors from io-ts are arrays already, so we just need to concatenate them.
+ */
+const validationErrorsSemigroup = {
+    concat: (a, b) => [...a, ...b],
+};
+/*
+ * This is a helper function to combine multiple io-ts validations into one.
+ *  t.array(...) works in the same way - it collects all the errors when decoding an array of values.
+ * 	However, it requires you to pass in a single io-ts validator as a parameter, which is not always convenient.
+ * 	Sometimes we have arrays of validation results received from function calls that don't have a validator instance.
+ */
+const combineValidationResults = (validationResults) => (0, function_1.pipe)(validationResults, RA.traverse(E.getApplicativeValidation(validationErrorsSemigroup))((validation) => validation));
+exports.combineValidationResults = combineValidationResults;

package/lib/validators/BasicTypes.d.ts

@@ -8,4 +8,3 @@ export declare const EmptyObject: t.Type<Record<never, never>, {
     [key: string]: unknown;
 }, unknown>;
 export declare const EmptyArray: t.Type<never[], never[], unknown>;
-export declare const AnyObject: t.RecordC<t.StringC, t.UnknownC>;

package/lib/validators/BasicTypes.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnyObject = exports.EmptyArray = exports.EmptyObject = exports.Boolean = exports.NumberOrNull = exports.Number = exports.StringOrNull = exports.String = void 0;
+exports.EmptyArray = exports.EmptyObject = exports.Boolean = exports.NumberOrNull = exports.Number = exports.StringOrNull = exports.String = 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 io_ts_types_1 = require("io-ts-types");
-exports.String = (0, io_ts_types_1.withMessage)(t.string, () => "The value must be a string");
-exports.StringOrNull = (0, io_ts_types_1.withMessage)(t.union([t.string, t.null]), () => "The value must be a string or null");
-exports.Number = (0, io_ts_types_1.withMessage)(t.number, () => "The value must be a number");
-exports.NumberOrNull = (0, io_ts_types_1.withMessage)(t.union([t.number, t.null]), () => "The value must be a number or null");
-exports.Boolean = (0, io_ts_types_1.withMessage)(t.boolean, () => "The value must be a boolean");
+const function_2 = require("./function");
+exports.String = (0, function_2.withCustomError)(t.string, () => "The value must be a string");
+exports.StringOrNull = (0, function_2.withCustomError)(t.union([t.string, t.null]), () => "The value must be a string or null");
+exports.Number = (0, function_2.withCustomError)(t.number, () => "The value must be a number");
+exports.NumberOrNull = (0, function_2.withCustomError)(t.union([t.number, t.null]), () => "The value must be a number or null");
+exports.Boolean = (0, function_2.withCustomError)(t.boolean, () => "The value must be a boolean");
 exports.EmptyObject = t.UnknownRecord.pipe(new t.Type("emptyObject", (u) => t.UnknownRecord.is(u), (u, c) => {
     if (Object.keys(u).length > 0)
         return t.failure(u, c, "The object is not empty.");
@@ -23,4 +23,3 @@ exports.EmptyArray = new t.Type("emptyArray", (u) => t.UnknownArray.is(u) && u.l
         return t.success(new Array());
     }));
 }, () => []);
-exports.AnyObject = (0, io_ts_types_1.withMessage)(t.record(t.string, t.unknown), () => "The value must be an object");

package/lib/validators/DefaultOrElse.js

@@ -6,7 +6,7 @@ const Either_1 = require("fp-ts/lib/Either");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const BasicTypes_1 = require("./BasicTypes");
 const DefaultOrElse = (inputValidator) => {
-    return (codec) => new t.Type("NullOrT", (u) => null === u || codec.is(u), (u) => {
+    return (codec) => new t.Type("DefaultOrElse", (u) => null === u || codec.is(u), (u) => {
         if ((0, Either_1.isRight)(inputValidator.decode(u)))
             return t.success(null);
         return codec.decode(u);

package/lib/validators/NonEmptyString.js

@@ -3,4 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const function_1 = require("./function");
-exports.default = (0, function_1.refineType)(t.string, "nonEmptyString", (s) => s.trim().length > 0);
+exports.default = (0, function_1.withCustomError)((0, function_1.refineType)(t.string, "nonEmptyString", (s) => s.trim().length > 0), () => "The value must be a non-empty string");

package/lib/validators/NullOrT.d.ts

@@ -0,0 +1,2 @@
+import * as t from "io-ts";
+export declare const NullOrElse: <A, O = A>(codec: t.Type<A, O, unknown>) => t.Type<A | null, O | undefined, unknown>;

package/lib/validators/NullOrT.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NullOrElse = void 0;
+const tslib_1 = require("tslib");
+const Either_1 = require("fp-ts/lib/Either");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const NullOrElse = (codec) => new t.Type("NullOrT", (u) => null === u || codec.is(u), (u) => {
+    if ((0, Either_1.isRight)(t.null.decode(u)))
+        return t.success(null);
+    return codec.decode(u);
+}, (chunk) => (chunk ? codec.encode(chunk) : undefined));
+exports.NullOrElse = NullOrElse;

package/lib/validators/function.d.ts

@@ -19,16 +19,16 @@ export declare function addType<A, O extends object, I, T extends string>(codec:
  *
  * @example
  * expect(
- * 		withFallbackMessage(
- * 			t.type({age: withMessage(t.number, () => 'Invalid child')}),
+ * 		withCustomError(
+ * 			t.type({age: withCustomError(t.number, () => 'Invalid child')}),
  * 			() => "Invalid parent"
  * 		)
  * ).toSubsetEqualLeft([{message: "Invalid child"}])
  * expect(
- * 		withFallbackMessage(
+ * 		withCustomError(
  * 			t.type({age: t.number}),
  * 			() => "Invalid parent"
  * 		)
  * ).toSubsetEqualLeft([{message: "Invalid parent"}])
  */
-export declare function withFallbackMessage<C extends t.Any>(codec: C, message: (i: t.InputOf<C>, c: t.Context) => string): C;
+export declare function withCustomError<C extends t.Any>(codec: C, message: (i: t.InputOf<C>, c: t.Context) => string): C;

package/lib/validators/function.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withFallbackMessage = exports.addType = exports.isEmpty = exports.objectToMap = exports.grouped = exports.formatDate = exports.formatDateTime = exports.filterDouble = exports.refineType = exports.nullable = void 0;
+exports.withCustomError = exports.addType = exports.isEmpty = exports.objectToMap = exports.grouped = exports.formatDate = exports.formatDateTime = exports.filterDouble = exports.refineType = exports.nullable = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 const function_1 = require("fp-ts/function");
@@ -66,19 +66,19 @@ exports.addType = addType;
  *
  * @example
  * expect(
- * 		withFallbackMessage(
- * 			t.type({age: withMessage(t.number, () => 'Invalid child')}),
+ * 		withCustomError(
+ * 			t.type({age: withCustomError(t.number, () => 'Invalid child')}),
  * 			() => "Invalid parent"
  * 		)
  * ).toSubsetEqualLeft([{message: "Invalid child"}])
  * expect(
- * 		withFallbackMessage(
+ * 		withCustomError(
  * 			t.type({age: t.number}),
  * 			() => "Invalid parent"
  * 		)
  * ).toSubsetEqualLeft([{message: "Invalid parent"}])
  */
-function withFallbackMessage(codec, message) {
+function withCustomError(codec, message) {
     return (0, io_ts_types_1.withValidate)(codec, (i, c) => {
         return fp_ts_1.either.mapLeft((errors) => {
             if (errors.find((error) => error.message)) {
@@ -97,4 +97,4 @@ function withFallbackMessage(codec, message) {
         })(codec.validate(i, c));
     });
 }
-exports.withFallbackMessage = withFallbackMessage;
+exports.withCustomError = withCustomError;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "2.2.0-alpha.9",
+	"version": "2.2.0-traverse.alpha-0",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",
@@ -67,7 +67,9 @@
 	"peerDependencies": {
 		"fp-ts": "^2.11.8",
 		"io-ts": "^2.2.16",
-		"io-ts-types": "^0.5.16"
+		"io-ts-types": "^0.5.16",
+		"uuid": "^9.0.0",
+		"@types/uuid": "^9.0.2"
 	},
 	"engines": {
 		"node": ">=12.7.0"

package/src/_internal/utils.ts

@@ -0,0 +1,39 @@
+import type { SliceContent, WidgetContent } from "../content"
+import type { StaticSlice, StaticWidget } from "../customtypes"
+
+export type TraverseContentFn = <
+	C extends WidgetContent | SliceContent,
+	D extends StaticWidget | StaticSlice,
+>({
+	path,
+	key,
+	apiId,
+	model,
+	content,
+}: {
+	path: ContentPath
+	key: string
+	apiId: string
+	model?: D | undefined
+	content: C
+}) => C | undefined
+
+export type ContentPathEntry = {
+	type:
+		| "CustomType"
+		| WidgetContent["__TYPE__"]
+		| SliceContent["__TYPE__"]
+		| "GroupItem"
+		| "primary"
+		| "items"
+	key: string
+}
+
+export type ContentPath = ReadonlyArray<ContentPathEntry>
+
+const PATH_SEPARATOR = "::"
+export const ContentPath = {
+	serialize(path: ContentPath): string {
+		return path.map((entry) => entry.key).join(PATH_SEPARATOR)
+	},
+}

package/src/common/Asset.ts

@@ -1,12 +1,10 @@
-export type AssetId = string
-
 export type Asset = {
-	id: AssetId
+	id: string
 	last_modified: string
 	kind: "image" | "all"
 	filename?: string
 	extension?: string
-	size?: string
+	size?: number
 	origin_url: string
 	url: string
 	width?: number
@@ -17,7 +15,8 @@ export type Asset = {
 }
 
 export const getAssetOrThrow =
-	(assets: Record<AssetId, Asset>) => (assetId: AssetId) => {
+	(assets: Record<Asset["id"], Asset | undefined>) =>
+	(assetId: Asset["id"]) => {
 		const asset = assets[assetId]
 		if (!asset) {
 			throw new Error(`Missing asset with id '${assetId}'!`)

package/src/common/Embed.ts

@@ -0,0 +1,22 @@
+// This type represents response format from oEmbed API
+export type Embed = {
+	type: string
+	version?: string | null
+	author_name?: string | null
+	author_url?: string | null
+	provider_name?: string | null
+	provider_url?: string | null
+	cache_age?: string | null
+	thumbnail_url?: string | null
+	thumbnail_width?: number | null
+	thumbnail_height?: number | null
+	html?: string | null
+	title?: string | null
+}
+
+export const getEmbedOrThrow =
+	(embeds: Record<string, Embed | undefined>) => (embedUrl: string) => {
+		const embed = embeds[embedUrl]
+		if (!embed) throw new Error(`Missing embed with url '${embedUrl}'`)
+		return embed
+	}

package/src/common/UUID.ts

@@ -0,0 +1,19 @@
+import * as t from "io-ts"
+import { validate as validateUUID } from "uuid"
+
+import { withCustomError } from "../validators/function"
+
+interface UUIDBrand {
+	readonly UUID: unique symbol
+}
+
+export const UUID = withCustomError(
+	t.brand(
+		t.string,
+		(s): s is t.Branded<string, UUIDBrand> => validateUUID(s),
+		"UUID",
+	),
+	() => "The value must be a valid UUID",
+)
+
+export type UUID = t.TypeOf<typeof UUID>

package/src/common/index.ts

@@ -1,2 +1,3 @@
 export * from "./Asset"
+export * from "./Embed"
 export * from "./WidgetKey"

package/src/content/Document.ts

@@ -3,8 +3,20 @@ import { isLeft, isRight } from "fp-ts/lib/Either"
 import { pipe } from "fp-ts/lib/function"
 import * as t from "io-ts"
 
+import { type TraverseContentFn, ContentPath } from "../_internal/utils"
 import { WidgetKey } from "../common"
-import { WidgetContent, WidgetLegacy } from "./fields"
+import {
+	type StaticCustomType,
+	type StaticWidget,
+	flattenStaticWidgets,
+} from "../customtypes"
+import {
+	SliceContent,
+	traverseGroupContent,
+	traverseSlices,
+	WidgetContent,
+	WidgetLegacy,
+} from "./fields"
 import {
 	defaultCtx,
 	FieldOrSliceType,
@@ -133,3 +145,86 @@ export const DocumentLegacy = {
 	parse: parseLegacyDocument,
 	encode: encodeToLegacyDocument,
 }
+
+/**
+ *
+ * @param model: can be optional if we simply want to loop through the content without any consideration for the attached model
+ * @param document: The content we actually want to iterate on in an immutable fashion
+ * @param transform: A user function that provides a way to transform any kind of content wherever it is in a structured Prismic object content.
+ * @returns a transformed document with the user's transformation applied with the transform function
+ */
+export function traverseDocument(document: Document, model?: StaticCustomType) {
+	return (transform: TraverseContentFn): Document => {
+		const fieldDefs =
+			model &&
+			flattenStaticWidgets(model).reduce<Record<string, StaticWidget>>(
+				(acc, [key, def]) => ({ ...acc, [key]: def }),
+				{},
+			)
+
+		return Object.entries(document).reduce((acc, [key, content]) => {
+			const fieldDef = fieldDefs && fieldDefs[key]
+
+			const path = [{ key, type: content.__TYPE__ }]
+			const transformedWidgetContent = (() => {
+				switch (content.__TYPE__) {
+					case "SliceContentType":
+						return traverseSlices({
+							path,
+							model:
+								fieldDef?.type === "Slices" || fieldDef?.type === "Choice"
+									? fieldDef
+									: undefined,
+							content,
+						})(transform)
+					case "GroupContentType":
+						return traverseGroupContent({
+							path,
+							model: fieldDef?.type === "Group" ? fieldDef : undefined,
+							content,
+						})(transform)
+					default:
+						return content
+				}
+			})()
+
+			const transformedWidget =
+				transformedWidgetContent &&
+				transform({
+					path,
+					key,
+					apiId: key,
+					model: fieldDef,
+					content: transformedWidgetContent,
+				})
+			return {
+				...acc,
+				...(transformedWidget ? { [key]: transformedWidget } : {}),
+			}
+		}, {})
+	}
+}
+
+/**
+ * The goal is to be able to collect all widgets or slices of a given type at any level of nesting inside a prismic content
+ *
+ * @param document parsed prismic content
+ * @param is typeguard to match specifically the type of widget we want to collect
+ * @returns a record containing the path of the widget as key and the typed collected content as value
+ */
+export function collectWidgets<W extends WidgetContent | SliceContent>(
+	document: Document,
+	is: (
+		content: WidgetContent | SliceContent,
+		path: ContentPath,
+	) => content is W,
+): Record<string, W> {
+	const collected: Record<string, W> = {}
+
+	traverseDocument(document)(({ content, path }) => {
+		const key = ContentPath.serialize(path)
+		if (is(content, path)) collected[key] = content
+		return content
+	})
+	return collected
+}