@prismicio/types-internal 3.17.0-alpha.2 → 3.17.0-pr.144.0c8207f

package/package.json

@@ -1,77 +1,90 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "3.17.0-alpha.2",
-	"description": "Prismic types for Custom Types and Prismic Data",
+	"version": "3.17.0-pr.144.0c8207f",
+	"description": "Prismic internal types for content and models",
 	"keywords": [
-		"typescript",
-		"prismic"
+		"prismic",
+		"typescript"
 	],
+	"license": "Apache-2.0",
+	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
 	"repository": {
 		"type": "git",
 		"url": "ssh://git@github.com/prismicio/prismic-types-internal.git"
 	},
-	"license": "Apache-2.0",
-	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
-	"main": "lib/index.js",
-	"types": "lib/index.d.ts",
 	"files": [
-		"lib",
-		"src"
+		"./dist",
+		"./src"
 	],
+	"type": "module",
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.cts",
+	"typesVersions": {
+		"*": {
+			"*": [
+				"./dist/index.d.ts"
+			],
+			"common": [
+				"./dist/common.d.ts"
+			],
+			"content": [
+				"./dist/content.d.ts"
+			],
+			"customtypes": [
+				"./dist/customtypes.d.ts"
+			],
+			"utils": [
+				"./dist/utils.d.ts"
+			],
+			"validators": [
+				"./dist/validators.d.ts"
+			]
+		}
+	},
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		},
+		"./package.json": "./package.json"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
 	"scripts": {
-		"build": "tsc",
-		"dev": "tsc --watch",
-		"format": "prettier --write .",
+		"build": "tsdown",
+		"dev": "tsdown --watch",
+		"format": "oxfmt",
 		"prepare": "npm run build",
-		"test": "jest --no-cache --silent=false --verbose=false --coverage",
-		"test:watch": "npm run test -- --watch",
-		"test:clear": "jest --clearCache",
-		"eslint": "eslint . --cache --cache-location .caches/eslint --cache-strategy content --ext js,ts,tsx --max-warnings 0",
-		"eslint-fix": "npm run eslint -- --fix",
-		"preflight": "npm run prettier && npm run build && npm run eslint && npm run test",
-		"prettier": "prettier --check .",
-		"prettier-write": "prettier --write ."
+		"lint": "oxlint --deny-warnings",
+		"types": "tsc --noEmit",
+		"unit": "vitest run --coverage",
+		"unit:watch": "vitest watch",
+		"test": "npm run lint && npm run types && npm run unit && npm run build"
 	},
 	"dependencies": {
-		"monocle-ts": "^2.3.11",
-		"newtype-ts": "^0.3.5",
-		"tslib": "^2.3.1",
-		"uuid": "^9.0.0"
+		"monocle-ts": "^2.3.13",
+		"newtype-ts": "^0.3.5"
 	},
 	"devDependencies": {
-		"@fast-check/jest": "^1.4.0",
-		"@relmify/jest-fp-ts": "^1.1.1",
-		"@types/jest": "^27.4.0",
-		"@types/uuid": "^9.0.2",
-		"@typescript-eslint/eslint-plugin": "^5.8.1",
-		"@typescript-eslint/parser": "^5.8.1",
-		"ava": "^3.15.0",
-		"eslint": "8.6.0",
-		"eslint-config-prettier": "8.3.0",
-		"eslint-plugin-only-warn": "1.0.3",
-		"eslint-plugin-simple-import-sort": "7.0.0",
-		"eslint-plugin-storybook": "0.5.5",
-		"fp-ts": "^2.11.8",
-		"io-ts": "^2.2.16",
-		"io-ts-types": "^0.5.16",
-		"jest": "^27.5.1",
-		"nyc": "^15.1.0",
-		"prettier": "^2.7.1",
-		"prettier-plugin-jsdoc": "^0.3.30",
-		"standard-version": "^9.3.2",
-		"ts-eager": "^2.0.2",
-		"ts-jest": "^27.1.3",
-		"typescript": "^4.5.5"
+		"@types/node": "^25.2.3",
+		"@vitest/coverage-v8": "^4.0.18",
+		"fp-ts": "^2.16.11",
+		"io-ts": "^2.2.22",
+		"io-ts-types": "^0.5.19",
+		"oxfmt": "^0.33.0",
+		"oxlint": "^1.48.0",
+		"tsdown": "^0.20.3",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.18"
 	},
 	"peerDependencies": {
-		"fp-ts": "^2.11.8",
-		"io-ts": "^2.2.16",
-		"io-ts-types": "^0.5.16"
+		"fp-ts": "^2.16.11",
+		"io-ts": "^2.2.22",
+		"io-ts-types": "^0.5.19"
 	},
 	"engines": {
-		"node": ">=12.7.0"
-	},
-	"publishConfig": {
-		"access": "public"
+		"node": ">=20"
 	}
 }

package/src/common/Asset.ts

@@ -15,8 +15,7 @@ export type Asset = {
 }
 
 export const getAssetOrThrow =
-	(assets: Record<Asset["id"], Asset | undefined>) =>
-	(assetId: Asset["id"]) => {
+	(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/HexaColorCode.ts

@@ -6,6 +6,5 @@ export type HexaColorCode = `#${string}`
 
 const hexaColorCodeRegex = /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/
 export const HexaColor = {
-	is: (strColor: string): strColor is HexaColorCode =>
-		hexaColorCodeRegex.test(strColor),
+	is: (strColor: string): strColor is HexaColorCode => hexaColorCodeRegex.test(strColor),
 }

package/src/common/UUID.ts

@@ -1,5 +1,4 @@
 import * as t from "io-ts"
-import { validate as validateUUID } from "uuid"
 
 import { withCustomError } from "../validators/function"
 
@@ -10,7 +9,11 @@ export interface UUIDBrand {
 export const UUID = withCustomError(
 	t.brand(
 		t.string,
-		(s): s is t.Branded<string, UUIDBrand> => validateUUID(s),
+		(s): s is t.Branded<string, UUIDBrand> =>
+			typeof s === "string" &&
+			/^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/i.test(
+				s,
+			),
 		"UUID",
 	),
 	() => "The value must be a valid UUID",

package/src/content/Document.ts

@@ -15,27 +15,33 @@ import {
 import {
 	groupContentWithDefaultValues,
 	isGroupContent,
+	isNestableContent,
+	isRepeatableContent,
 	isSlicesContent,
+	isTableContent,
 	migrateSliceItem,
 	NestableContentDefaultValue,
 	slicesContentWithDefaultValues,
 	traverseGroupContent,
+	traverseGroupContentWithModel,
 	traverseRepeatableContent,
+	traverseRepeatableContentWithModel,
 	traverseSlices,
+	traverseSlicesWithModel,
 	traverseTableContent,
+	traverseTableContentWithModel,
 	WidgetContent,
 	WidgetLegacy,
 } from "./fields"
-import {
-	defaultCtx,
-	FieldOrSliceType,
-	LegacyContentCtx,
-	WithTypes,
-} from "./LegacyContentCtx"
-import {
-	ContentPath,
+import type { LegacyContentCtx, WithTypes } from "./LegacyContentCtx";
+import { defaultCtx, FieldOrSliceType } from "./LegacyContentCtx"
+import type {
 	TraverseSliceContentFn,
+	TraverseSliceContentWithModelFn,
 	TraverseWidgetContentFn,
+	TraverseWidgetContentWithModelFn} from "./utils";
+import {
+	ContentPath
 } from "./utils"
 
 export const Document = t.record(WidgetKey, WidgetContent)
@@ -59,16 +65,13 @@ const DocumentLegacyCodec = (
 			return pipe(
 				legacyDocReader.decode(doc),
 				either.map((parsedDoc) => {
-					return Object.entries(parsedDoc).reduce(
-						(acc, [widgetKey, widgetValue]) => {
-							const widgetCtx = defaultCtx(widgetKey, allTypes, allKeys)
-							const parsedW = WidgetLegacy(widgetCtx).decode(widgetValue)
-							if (!parsedW || isLeft(parsedW)) return acc
-
-							return { ...acc, [widgetKey]: parsedW.right }
-						},
-						{},
-					)
+					return Object.entries(parsedDoc).reduce((acc, [widgetKey, widgetValue]) => {
+						const widgetCtx = defaultCtx(widgetKey, allTypes, allKeys)
+						const parsedW = WidgetLegacy(widgetCtx).decode(widgetValue)
+						if (!parsedW || isLeft(parsedW)) return acc
+
+						return { ...acc, [widgetKey]: parsedW.right }
+					}, {})
 				}),
 			)
 		},
@@ -107,10 +110,7 @@ function extractMetadata(data: { [p: string]: unknown }): {
 				if (isRight(decodedValue)) {
 					return {
 						...acc,
-						types: acc.types.set(
-							k.substring(0, k.length - 5),
-							decodedValue.right,
-						),
+						types: acc.types.set(k.substring(0, k.length - 5), decodedValue.right),
 					}
 				}
 			}
@@ -119,18 +119,11 @@ function extractMetadata(data: { [p: string]: unknown }): {
 				if (isRight(decodedValue)) {
 					return {
 						...acc,
-						keys: acc.keys.set(
-							k.substring(0, k.length - 4),
-							decodedValue.right,
-						),
+						keys: acc.keys.set(k.substring(0, k.length - 4), decodedValue.right),
 					}
 				}
 			}
-			if (
-				!k.endsWith("_POSITION") &&
-				!k.endsWith("_TYPE") &&
-				!k.endsWith("_KEY")
-			) {
+			if (!k.endsWith("_POSITION") && !k.endsWith("_TYPE") && !k.endsWith("_KEY")) {
 				return {
 					...acc,
 					widgets: {
@@ -215,41 +208,36 @@ export function fillDocumentWithDefaultValues(
 	document: Document,
 ): Document {
 	const { fields } =
-		customType && StaticCustomType.is(customType)
-			? simplifyCustomType(customType)
-			: customType
-
-	return Object.entries(fields).reduce<Document>(
-		(updatedDocument, [fieldKey, fieldDef]) => {
-			const fieldContent = document[fieldKey]
-
-			const updatedField = (() => {
-				switch (fieldDef.type) {
-					case "Group":
-						return isGroupContent(fieldContent)
-							? groupContentWithDefaultValues(fieldDef, fieldContent)
-							: fieldContent
-					case "Choice":
-					case "Slices":
-						return isSlicesContent(fieldContent)
-							? slicesContentWithDefaultValues(fieldDef, fieldContent)
-							: fieldContent
-					default:
-						return fieldContent === undefined && NestableWidget.is(fieldDef)
-							? NestableContentDefaultValue(fieldDef)
-							: fieldContent
-				}
-			})()
+		customType && StaticCustomType.is(customType) ? simplifyCustomType(customType) : customType
 
-			return updatedField
-				? {
-						...updatedDocument,
-						[fieldKey]: updatedField,
-				  }
-				: updatedDocument
-		},
-		document,
-	)
+	return Object.entries(fields).reduce<Document>((updatedDocument, [fieldKey, fieldDef]) => {
+		const fieldContent = document[fieldKey]
+
+		const updatedField = (() => {
+			switch (fieldDef.type) {
+				case "Group":
+					return isGroupContent(fieldContent)
+						? groupContentWithDefaultValues(fieldDef, fieldContent)
+						: fieldContent
+				case "Choice":
+				case "Slices":
+					return isSlicesContent(fieldContent)
+						? slicesContentWithDefaultValues(fieldDef, fieldContent)
+						: fieldContent
+				default:
+					return fieldContent === undefined && NestableWidget.is(fieldDef)
+						? NestableContentDefaultValue(fieldDef)
+						: fieldContent
+			}
+		})()
+
+		return updatedField
+			? {
+					...updatedDocument,
+					[fieldKey]: updatedField,
+				}
+			: updatedDocument
+	}, document)
 }
 /**
  * @param model: Can be optional if we simply want to loop through the content
@@ -274,9 +262,7 @@ export function traverseDocument({
 		| undefined
 }) {
 	const model =
-		customType && StaticCustomType.is(customType)
-			? simplifyCustomType(customType)
-			: customType
+		customType && StaticCustomType.is(customType) ? simplifyCustomType(customType) : customType
 	return ({
 		transformWidget = ({ content }) => content,
 		transformSlice = ({ content }) => content,
@@ -391,11 +377,9 @@ export function migrateDocument(
 				fields: Record<string, StaticWidget>
 		  },
 ) {
-	const model = StaticCustomType.is(customType)
-		? simplifyCustomType(customType)
-		: customType
-	const needsMigration = Object.values(collectSharedSlices(model)).some(
-		(slice) => Boolean(slice.legacyPaths),
+	const model = StaticCustomType.is(customType) ? simplifyCustomType(customType) : customType
+	const needsMigration = Object.values(collectSharedSlices(model)).some((slice) =>
+		Boolean(slice.legacyPaths),
 	)
 
 	if (!needsMigration) return document
@@ -407,3 +391,111 @@ export function migrateDocument(
 		transformSlice: migrateSliceItem,
 	})
 }
+
+export function traverseDocumentWithModel({
+	document,
+	customType,
+}: {
+	document: Document
+	customType:
+		| StaticCustomType
+		| {
+				customTypeId: string
+				fields: Record<string, StaticWidget>
+		  }
+}) {
+	const model = StaticCustomType.is(customType) ? simplifyCustomType(customType) : customType
+
+	return ({
+		transformWidget,
+		transformSlice,
+	}: {
+		transformWidget: TraverseWidgetContentWithModelFn
+		transformSlice: TraverseSliceContentWithModelFn
+	}): Document => {
+		return Object.entries(model.fields).reduce<Document>((acc, [key, fieldModel]) => {
+			const content = document[key]
+
+			const path = ContentPath.make([
+				{ key: model.customTypeId, type: "CustomType" },
+				{ key, type: "Widget" },
+			])
+
+			const transformedWidget = (() => {
+				switch (fieldModel.type) {
+					case "Choice":
+					case "Slices": {
+						const slicesContent = isSlicesContent(content) ? content : undefined
+						return traverseSlicesWithModel({
+							path,
+							key,
+							model: fieldModel,
+							content: slicesContent,
+						})({ transformWidget, transformSlice })
+					}
+					case "Group": {
+						const groupContent = isGroupContent(content) ? content : undefined
+						return traverseGroupContentWithModel({
+							path,
+							key,
+							model: fieldModel,
+							content: groupContent,
+						})(transformWidget)
+					}
+					case "Link": {
+						if (fieldModel.config?.repeat === true) {
+							const repeatableContent = isRepeatableContent(content) ? content : undefined
+							return traverseRepeatableContentWithModel({
+								path,
+								key,
+								model: fieldModel,
+								content: repeatableContent,
+							})(transformWidget)
+						}
+						const nestableContent = isNestableContent(content) ? content : undefined
+						return transformWidget({
+							path,
+							key,
+							apiId: key,
+							model: fieldModel,
+							content: nestableContent,
+						})
+					}
+					case "Table": {
+						const tableContent = isTableContent(content) ? content : undefined
+						return traverseTableContentWithModel({
+							path,
+							key,
+							model: fieldModel,
+							content: tableContent,
+						})(transformWidget)
+					}
+					case "UID": {
+						return transformWidget({
+							path,
+							key,
+							apiId: key,
+							model: fieldModel,
+							content,
+						})
+					}
+					default: {
+						const nestableContent = isNestableContent(content) ? content : undefined
+						return transformWidget({
+							path,
+							key,
+							apiId: key,
+							model: fieldModel,
+							content: nestableContent,
+						})
+					}
+				}
+			})()
+
+			return {
+				...acc,
+				...(transformedWidget ? { [key]: transformedWidget } : {}),
+			}
+		}, {})
+	}
+}

package/src/content/LegacyContentCtx.ts

@@ -1,5 +1,4 @@
 import * as t from "io-ts"
-import { v4 as uuid } from "uuid"
 
 import { FieldType, SlicesTypes } from "../customtypes/widgets"
 
@@ -46,19 +45,15 @@ export class LegacyContentCtx {
 		this.allTypes = allTypes || new Map<string, FieldOrSliceType>()
 		this.allKeys = allKeys || new Map<string, string>()
 
-		const prefixedKey = Array.of(this.fieldPath, [this.fieldKey])
-			.flat()
-			.join(".")
+		const prefixedKey = Array.of(this.fieldPath, [this.fieldKey]).flat().join(".")
 
-		const prefixedContentKey = Array.of(this.contentPath, [this.contentKey])
-			.flat()
-			.join(".")
+		const prefixedContentKey = Array.of(this.contentPath, [this.contentKey]).flat().join(".")
 
 		this.prefixedKey = prefixedKey
 		this.keyOfType = `${prefixedKey}_TYPE`
 		this.keyOfKey = `${prefixedContentKey}_KEY`
 		this.fieldType = this.allTypes.get(this.prefixedKey)
-		this.fieldContentKey = this.allKeys.get(prefixedContentKey) ?? uuid()
+		this.fieldContentKey = this.allKeys.get(prefixedContentKey) ?? crypto.randomUUID()
 	}
 
 	withContentKey(contentKey: string): LegacyContentCtx {