@prismicio/types-internal 3.17.0 → 4.0.0-canary.65d3262

package/src/content/legacy/link.ts

@@ -0,0 +1,194 @@
+import { z } from "zod/mini"
+
+import { NonEmptyStringSchema } from "../../common/nonEmptyString"
+
+export const LinkKind = {
+	Image: "image",
+	File: "file",
+	Media: "media",
+	Document: "document",
+	External: "web",
+	Any: "any",
+} as const
+
+export const LinkType = {
+	Image: "ImageLink",
+	File: "FileLink",
+	Document: "DocumentLink",
+	External: "ExternalLink",
+	Media: "MediaLink",
+	Any: "AnyLink",
+} as const
+
+// Image
+export const FilledImageLinkValueLegacySchema = z.strictObject({
+	// `kind` was normalized to the literal (legacy behavior)
+	kind: z.pipe(
+		z.string(),
+		z.transform(() => LinkKind.Image),
+	),
+	id: z.string(),
+	url: z.string(),
+	height: z.string(),
+	width: z.string(),
+	size: z.string(),
+	name: z.string(),
+	date: z.nullish(z.string()),
+})
+
+export const EmptyImageLinkValueLegacySchema = z.strictObject({
+	kind: z.literal(LinkKind.Image),
+})
+
+// File
+export const FilledFileLinkValueLegacySchema = z.strictObject({
+	// `kind` was normalized to the literal (legacy behavior)
+	kind: z.pipe(
+		z.string(),
+		z.transform(() => LinkKind.File),
+	),
+	id: z.string(),
+	url: z.string(),
+	name: z.string(),
+	size: z.transform((value) => (typeof value === "string" ? value : "0")),
+	date: z.nullish(z.string()),
+})
+
+export const EmptyFileLinkValueLegacySchema = z.strictObject({
+	kind: z.literal(LinkKind.File),
+})
+
+// Media
+
+// Media link only represent the empty state as they turn into
+// file or image links when they filled.
+export const EmptyMediaLinkValueLegacySchema = z.strictObject({
+	kind: z.literal(LinkKind.Media),
+})
+
+// Document
+export const FilledDocumentLinkValueLegacySchema = z.strictObject({
+	// `kind` is not part of the filled schema... (legacy behavior)
+	// We transform it to the literal for consistency.
+	kind: z.pipe(
+		z.optional(z.literal(LinkKind.Document)),
+		z.transform(() => LinkKind.Document),
+	),
+	id: NonEmptyStringSchema,
+})
+
+export const EmptyDocumentLinkValueLegacySchema = z.strictObject({
+	kind: z.literal(LinkKind.Document),
+})
+
+// External
+export const FilledExternalLinkValueLegacySchema = z.strictObject({
+	// It's odd that `kind` is optional here... (legacy behavior)
+	// We transform it to the literal for consistency.
+	kind: z.pipe(
+		z.optional(z.literal(LinkKind.External)),
+		z.transform(() => LinkKind.External),
+	),
+	url: z.string(),
+	target: z.nullish(z.string()),
+	preview: z.nullish(
+		z.strictObject({
+			title: z.optional(z.string()),
+		}),
+	),
+})
+
+export const EmptyExternalLinkValueLegacySchema = z.strictObject({
+	kind: z.literal(LinkKind.External),
+})
+
+// Any
+export const AnyLinkLegacySchema = z.strictObject({
+	kind: z.transform(() => LinkKind.Any),
+})
+
+// All
+
+export const FilledLinkValueLegacySchema: z.ZodMiniType<FilledLinkValueLegacy> = z.union([
+	FilledImageLinkValueLegacySchema,
+	FilledFileLinkValueLegacySchema,
+	FilledDocumentLinkValueLegacySchema,
+	FilledExternalLinkValueLegacySchema,
+])
+
+type FilledImageLinkValueLegacy = z.infer<typeof FilledImageLinkValueLegacySchema>
+type FilledFileLinkValueLegacy = z.infer<typeof FilledFileLinkValueLegacySchema>
+type FilledDocumentLinkValueLegacy = z.infer<typeof FilledDocumentLinkValueLegacySchema>
+type FilledExternalLinkValueLegacy = z.infer<typeof FilledExternalLinkValueLegacySchema>
+export type FilledLinkValueLegacy =
+	| FilledImageLinkValueLegacy
+	| FilledFileLinkValueLegacy
+	| FilledDocumentLinkValueLegacy
+	| FilledExternalLinkValueLegacy
+
+const EmptyLinkValueLegacySchema: z.ZodMiniType<EmptyLinkValueLegacy> = z.union([
+	EmptyImageLinkValueLegacySchema,
+	EmptyFileLinkValueLegacySchema,
+	EmptyMediaLinkValueLegacySchema,
+	EmptyDocumentLinkValueLegacySchema,
+	EmptyExternalLinkValueLegacySchema,
+	AnyLinkLegacySchema,
+])
+
+type EmptyImageLinkValueLegacy = z.infer<typeof EmptyImageLinkValueLegacySchema>
+type EmptyFileLinkValueLegacy = z.infer<typeof EmptyFileLinkValueLegacySchema>
+type EmptyMediaLinkValueLegacy = z.infer<typeof EmptyMediaLinkValueLegacySchema>
+type EmptyDocumentLinkValueLegacy = z.infer<typeof EmptyDocumentLinkValueLegacySchema>
+type EmptyExternalLinkValueLegacy = z.infer<typeof EmptyExternalLinkValueLegacySchema>
+type AnyLinkLegacy = z.infer<typeof AnyLinkLegacySchema>
+export type EmptyLinkValueLegacy =
+	| EmptyImageLinkValueLegacy
+	| EmptyFileLinkValueLegacy
+	| EmptyMediaLinkValueLegacy
+	| EmptyDocumentLinkValueLegacy
+	| EmptyExternalLinkValueLegacy
+	| AnyLinkLegacy
+
+const LinkValueLegacySchema: z.ZodMiniType<LinkValueLegacy> = z.union([
+	FilledLinkValueLegacySchema,
+	EmptyLinkValueLegacySchema,
+])
+
+export type LinkValueLegacy = FilledLinkValueLegacy | EmptyLinkValueLegacy
+
+// We cannot use z.extend here because we're working with unions.
+// z.intersection wouldn't work also for the same reason.
+export const LinkLegacySchema = z.pipe(
+	z.pipe(
+		z.pipe(
+			z.record(z.string(), z.unknown()),
+			z.transform(
+				({
+					key,
+					text,
+					variant,
+					...value
+				}): {
+					key?: unknown
+					text?: unknown
+					variant?: unknown
+					value: Record<string, unknown>
+				} => ({ key, text, variant, value }),
+			),
+		),
+		z.object({
+			key: z.optional(z.string()),
+			text: z.optional(z.string()),
+			variant: z.optional(z.string()),
+			value: LinkValueLegacySchema as z.ZodMiniType<LinkValueLegacy, Record<string, unknown>>,
+		}),
+	),
+	z.transform(({ key, text, variant, value }) => ({
+		key: z.uuidv4().safeParse(key).data ?? crypto.randomUUID(),
+		...(text ? { text } : {}),
+		...(variant ? { variant } : {}),
+		...value,
+	})),
+)
+
+export type LinkLegacy = z.infer<typeof LinkLegacySchema>

package/src/content/legacy/nestable.ts

@@ -0,0 +1,55 @@
+import { z } from "zod/mini"
+
+import type { BooleanLegacy } from "./boolean"
+import { BooleanLegacySchema } from "./boolean"
+import type { EmbedLegacy } from "./embed"
+import { EmbedLegacyLooseSchema } from "./embed"
+import type { EmptyLegacy } from "./empty"
+import { EmptyLegacySchema } from "./empty"
+import type { StringLegacy } from "./field"
+import { StringLegacySchema } from "./field"
+import type { GeoPointLegacy } from "./geopoint"
+import { GeoPointLegacySchema } from "./geopoint"
+import type { ImageLegacy } from "./image"
+import { ImageLegacySchema } from "./image"
+import type { IntegrationFieldLegacy } from "./integrationField"
+import { IntegrationFieldLegacySchema } from "./integrationField"
+import type { LinkLegacy } from "./link"
+import { LinkLegacySchema } from "./link"
+import type { RepeatableLegacy } from "./repeatable"
+import { RepeatableLegacySchema } from "./repeatable"
+import type { RichTextLegacy } from "./richText"
+import { RichTextLegacySchema } from "./richText"
+import type { SeparatorLegacy } from "./separator"
+import { SeparatorLegacySchema } from "./separator"
+import type { TableLegacy } from "./table"
+import { TableLegacySchema } from "./table"
+
+export const NestableLegacySchema: z.ZodMiniType<NestableLegacy> = z.union([
+	EmptyLegacySchema,
+	BooleanLegacySchema,
+	EmbedLegacyLooseSchema,
+	StringLegacySchema,
+	GeoPointLegacySchema,
+	ImageLegacySchema,
+	IntegrationFieldLegacySchema,
+	LinkLegacySchema,
+	RepeatableLegacySchema,
+	RichTextLegacySchema,
+	SeparatorLegacySchema,
+	TableLegacySchema,
+])
+
+export type NestableLegacy =
+	| EmptyLegacy
+	| BooleanLegacy
+	| EmbedLegacy
+	| StringLegacy
+	| GeoPointLegacy
+	| ImageLegacy
+	| IntegrationFieldLegacy
+	| LinkLegacy
+	| RepeatableLegacy
+	| RichTextLegacy
+	| SeparatorLegacy
+	| TableLegacy

package/src/content/legacy/repeatable.ts

@@ -0,0 +1,7 @@
+import { z } from "zod/mini"
+
+// Keep the legacy schema non-lossy; item-level link decoding lives in
+// `codec/repeatable.ts`, where the field model is available.
+export const RepeatableLegacySchema = z.array(z.unknown())
+
+export type RepeatableLegacy = z.infer<typeof RepeatableLegacySchema>

package/src/content/legacy/richText.ts

@@ -0,0 +1,198 @@
+import { z } from "zod/mini"
+
+// It's important to only import the types here to
+// avoid runtime circular dependencies!
+import type { EmbedContentSchema } from "../embed"
+import type { ImageViewContentSchema } from "../image"
+import type { FilledLinkValueContent, FilledLinkValueContentSchema } from "../link"
+import { EmbedLegacyLooseSchema } from "./embed"
+import { ImageViewLegacySchema } from "./image"
+import { FilledLinkValueLegacySchema } from "./link"
+import type { FilledLinkValueLegacy } from "./link"
+
+export const RichTextNodeType = {
+	paragraph: "paragraph",
+	heading1: "heading1",
+	heading2: "heading2",
+	heading3: "heading3",
+	heading4: "heading4",
+	heading5: "heading5",
+	heading6: "heading6",
+	preformatted: "preformatted",
+	oListItem: "o-list-item",
+	listItem: "list-item",
+	image: "image",
+	embed: "embed",
+	hyperlink: "hyperlink",
+	strong: "strong",
+	em: "em",
+} as const
+
+// Spans
+type HyperlinkSpan<TData extends FilledLinkValueLegacy | FilledLinkValueContent> = {
+	type: typeof RichTextNodeType.hyperlink
+	start: number
+	end: number
+	data: TData
+}
+
+const getHyperlinkSpanSchema = <
+	TData extends typeof FilledLinkValueLegacySchema | typeof FilledLinkValueContentSchema,
+>(
+	data: TData,
+) =>
+	z.object({
+		type: z.literal(RichTextNodeType.hyperlink),
+		start: z.number(),
+		end: z.number(),
+		data,
+	})
+
+type LabelSpan = {
+	type: "label"
+	start: number
+	end: number
+	data: string
+}
+
+const LabelSpanSchema: z.ZodMiniType<LabelSpan> = z.object({
+	type: z.literal("label"),
+	start: z.number(),
+	end: z.number(),
+	data: z.pipe(
+		z.unknown(),
+		z.transform((value) => (typeof value === "string" && value.length > 0 ? value : "")),
+	),
+})
+
+type BasicSpan = {
+	type: typeof RichTextNodeType.strong | typeof RichTextNodeType.em | "list-item"
+	start: number
+	end: number
+}
+
+const BasicSpanSchema: z.ZodMiniType<BasicSpan> = z.object({
+	type: z.union([
+		z.literal(RichTextNodeType.strong),
+		z.literal(RichTextNodeType.em),
+		z.literal("list-item"), // legacy case
+	]),
+	start: z.number(),
+	end: z.number(),
+})
+
+export type Span<TLink extends FilledLinkValueLegacy | FilledLinkValueContent> =
+	| HyperlinkSpan<TLink>
+	| LabelSpan
+	| BasicSpan
+
+// oxlint-disable-next-line explicit-module-boundary-types
+export const getSpanSchema = <
+	TLinkSchema extends typeof FilledLinkValueLegacySchema | typeof FilledLinkValueContentSchema,
+>(
+	linkSchema: TLinkSchema,
+) => z.union([getHyperlinkSpanSchema(linkSchema), LabelSpanSchema, BasicSpanSchema])
+
+// Text blocks
+const TextBlockTypeSchema = z.union([
+	z.literal(RichTextNodeType.paragraph),
+	z.literal(RichTextNodeType.heading1),
+	z.literal(RichTextNodeType.heading2),
+	z.literal(RichTextNodeType.heading3),
+	z.literal(RichTextNodeType.heading4),
+	z.literal(RichTextNodeType.heading5),
+	z.literal(RichTextNodeType.heading6),
+	z.literal(RichTextNodeType.preformatted),
+	z.literal(RichTextNodeType.oListItem),
+	z.literal(RichTextNodeType.listItem),
+])
+
+// oxlint-disable-next-line explicit-module-boundary-types
+export const getTextBlockSchema = <
+	TLinkSchema extends typeof FilledLinkValueLegacySchema | typeof FilledLinkValueContentSchema,
+>(
+	linkSchema: TLinkSchema,
+) =>
+	z.object({
+		type: TextBlockTypeSchema,
+		content: z.object({
+			text: z.string(),
+			spans: z.optional(
+				z.pipe(
+					z.array(z.unknown()),
+					z.transform((spans) => {
+						const spanSchema = getSpanSchema(linkSchema)
+
+						// Filter out invalid spans and order them by start position
+						return spans
+							.flatMap((maybeSpan) => {
+								const parsed = spanSchema.safeParse(maybeSpan)
+								return parsed.success ? [parsed.data] : []
+							})
+							.sort((a, b) => a.start - b.start)
+					}),
+				),
+			),
+		}),
+		label: z.optional(z.string()),
+		direction: z.optional(z.string()),
+	})
+
+const TextBlockLegacySchema = getTextBlockSchema(FilledLinkValueLegacySchema)
+
+type TextBlockLegacy = z.infer<typeof TextBlockLegacySchema>
+
+// Image block
+
+// oxlint-disable-next-line explicit-module-boundary-types
+export const getImageBlockSchema = <
+	TData extends typeof ImageViewLegacySchema | typeof ImageViewContentSchema,
+	TLinkTo extends typeof FilledLinkValueLegacySchema | typeof FilledLinkValueContentSchema,
+>(
+	data: TData,
+	linkTo: TLinkTo,
+) =>
+	z.object({
+		type: z.literal(RichTextNodeType.image),
+		data: z.extend(data, { linkTo: z.nullish(linkTo) }),
+		label: z.nullish(z.string()),
+		direction: z.nullish(z.string()),
+	})
+
+const ImageBlockLegacySchema = getImageBlockSchema(
+	ImageViewLegacySchema,
+	FilledLinkValueLegacySchema,
+)
+
+type ImageBlockLegacy = z.infer<typeof ImageBlockLegacySchema>
+
+// Embed block
+// oxlint-disable-next-line explicit-module-boundary-types
+export const getEmbedBlockSchema = <
+	TData extends typeof EmbedLegacyLooseSchema | typeof EmbedContentSchema,
+>(
+	data: TData,
+) =>
+	z.object({
+		type: z.literal(RichTextNodeType.embed),
+		data,
+		label: z.nullish(z.string()),
+		direction: z.nullish(z.string()),
+	})
+
+const EmbedBlockLegacySchema = getEmbedBlockSchema(EmbedLegacyLooseSchema)
+
+type EmbedBlockLegacy = z.infer<typeof EmbedBlockLegacySchema>
+
+// Blocks
+export const RichTextLegacyBlockSchema: z.ZodMiniType<RichTextLegacyBlock> = z.union([
+	TextBlockLegacySchema,
+	ImageBlockLegacySchema,
+	EmbedBlockLegacySchema,
+])
+
+export type RichTextLegacyBlock = TextBlockLegacy | ImageBlockLegacy | EmbedBlockLegacy
+
+export const RichTextLegacySchema = z.array(RichTextLegacyBlockSchema)
+
+export type RichTextLegacy = z.infer<typeof RichTextLegacySchema>

package/src/content/legacy/separator.ts

@@ -0,0 +1,6 @@
+import { z } from "zod/mini"
+
+// v3 SeparatorLegacy decode accepts any input and normalizes to SeparatorContent.
+export const SeparatorLegacySchema = z.unknown()
+
+export type SeparatorLegacy = z.infer<typeof SeparatorLegacySchema>

package/src/content/legacy/slice.ts

@@ -0,0 +1,38 @@
+import { z } from "zod/mini"
+
+import { GroupItemLegacySchema, NestableAndGroupLegacySchema } from "./group"
+
+// Legacy (before 2020)
+export const LegacySliceLegacySchema = NestableAndGroupLegacySchema
+
+export type LegacySliceLegacy = z.infer<typeof LegacySliceLegacySchema>
+
+// Composite (2020 to 2021)
+// Keep non-repeat values raw here: array-shaped legacy payloads are ambiguous until
+// `codec/slice.ts` resolves the field model and picks the right decoder.
+export const CompositeSliceLegacySchema = z.object({
+	"non-repeat": z.optional(z.record(z.string(), z.unknown())),
+	repeat: z.optional(z.array(GroupItemLegacySchema)),
+})
+
+export type CompositeSliceLegacy = z.infer<typeof CompositeSliceLegacySchema>
+
+// Shared (2021 to present)
+// Keep primary values raw here: array-shaped legacy payloads are ambiguous until
+// `codec/slice.ts` resolves the field model and picks the right decoder.
+export const SharedSliceLegacySchema = z.object({
+	variation: z.string(),
+	primary: z.transform((value) => z.record(z.string(), z.unknown()).safeParse(value).data || {}),
+	items: z.transform((value) => z.array(GroupItemLegacySchema).safeParse(value).data || []),
+})
+
+export type SharedSliceLegacy = z.infer<typeof SharedSliceLegacySchema>
+
+// All
+export const SliceLegacySchema: z.ZodMiniType<SliceLegacy> = z.union([
+	LegacySliceLegacySchema,
+	CompositeSliceLegacySchema,
+	SharedSliceLegacySchema,
+])
+
+export type SliceLegacy = LegacySliceLegacy | CompositeSliceLegacy | SharedSliceLegacy

package/src/content/legacy/slices.ts

@@ -0,0 +1,17 @@
+import { z } from "zod/mini"
+
+import { SliceLegacySchema } from "./slice"
+
+// Item
+export const SliceItemLegacySchema = z.object({
+	key: z.string(),
+	label: z.nullish(z.string()),
+	value: SliceLegacySchema,
+})
+
+export type SliceItemLegacy = z.infer<typeof SliceItemLegacySchema>
+
+// Slices
+export const SlicesLegacySchema = z.array(SliceItemLegacySchema)
+
+export type SlicesLegacy = z.infer<typeof SlicesLegacySchema>

package/src/content/legacy/table.ts

@@ -0,0 +1,39 @@
+import { z } from "zod/mini"
+
+// It's important to only import the types here to
+// avoid runtime circular dependencies!
+import type { RichTextContentSchema } from "../richText"
+import { RichTextLegacySchema } from "./richText"
+
+// Cell
+const getTableCellSchema = <
+	TContent extends typeof RichTextLegacySchema | typeof RichTextContentSchema,
+>(
+	content: TContent,
+) =>
+	z.object({
+		key: z.transform((value) => z.uuidv4().safeParse(value).data || crypto.randomUUID()),
+		type: z.union([z.literal("tableHeader"), z.literal("tableCell")]),
+		content,
+		columnWidth: z.optional(z.number()),
+	})
+
+// Row
+// oxlint-disable-next-line explicit-module-boundary-types
+export const getTableRowSchema = <
+	TRichText extends typeof RichTextLegacySchema | typeof RichTextContentSchema,
+>(
+	richTextSchema: TRichText,
+) =>
+	z.strictObject({
+		key: z.transform((value) => z.uuidv4().safeParse(value).data || crypto.randomUUID()),
+		type: z.literal("tableRow"),
+		content: z.array(getTableCellSchema(richTextSchema)),
+	})
+
+// Table
+export const TableLegacySchema = z.strictObject({
+	content: z.array(getTableRowSchema(RichTextLegacySchema)),
+})
+
+export type TableLegacy = z.infer<typeof TableLegacySchema>

package/src/content/legacy/uid.ts

@@ -0,0 +1,6 @@
+import { z } from "zod/mini"
+
+// TODO: Can't we add business logic UID shape validation here? (not uniqueness but format)
+export const UIDLegacySchema = z.string()
+
+export type UIDLegacy = z.infer<typeof UIDLegacySchema>

package/src/content/legacy/widget.ts

@@ -0,0 +1,19 @@
+import { z } from "zod/mini"
+
+import type { GroupLegacy } from "./group"
+import { GroupLegacySchema } from "./group"
+import type { NestableLegacy } from "./nestable"
+import { NestableLegacySchema } from "./nestable"
+import type { SlicesLegacy } from "./slices"
+import { SlicesLegacySchema } from "./slices"
+import type { UIDLegacy } from "./uid"
+import { UIDLegacySchema } from "./uid"
+
+export const WidgetLegacySchema: z.ZodMiniType<WidgetLegacy> = z.union([
+	UIDLegacySchema,
+	GroupLegacySchema,
+	SlicesLegacySchema,
+	NestableLegacySchema,
+])
+
+export type WidgetLegacy = UIDLegacy | GroupLegacy | SlicesLegacy | NestableLegacy