@prismicio/types-internal 2.2.0-alpha.3 → 2.2.0-alpha.4

package/lib/import/converters/fields/nestable/Link.d.ts

@@ -1,3 +1,3 @@
-import type { ImportLink } from "../../../validators";
 import type { LinkContent } from "../../../../content";
+import type { ImportLink } from "../../../validators";
 export declare const linkConverter: (field: ImportLink["value"]) => LinkContent | undefined;

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

@@ -2,18 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.linkConverter = void 0;
 const linkConverter = (field) => {
-    if (field === null)
+    if (field === null) {
         return;
-    if (field.link_type === "Document" || field.link_type === "Media") {
-        throw new Error("`Document` and `Media` links are not yet supported");
     }
-    return {
-        value: {
-            url: field.url,
-            target: field.target,
-            __TYPE__: "ExternalLink",
-        },
-        __TYPE__: "LinkContent",
-    };
+    switch (field.link_type) {
+        case "Web":
+            return {
+                value: {
+                    url: field.url,
+                    target: field.target,
+                    __TYPE__: "ExternalLink",
+                },
+                __TYPE__: "LinkContent",
+            };
+        case "Document":
+            return {
+                value: {
+                    id: field.id,
+                    __TYPE__: "DocumentLink",
+                },
+                __TYPE__: "LinkContent",
+            };
+        // TODO: https://linear.app/prismic/issue/AGE-90/[content-validation-and-error-management]-link-to-media
+        case "Media":
+            return undefined;
+    }
 };
 exports.linkConverter = linkConverter;

package/lib/import/converters/fields/nestable/Nestable.js

@@ -22,6 +22,8 @@ function convertNestableWidget(field, assets) {
             return (0, _1.embedConverter)(field.value);
         case "GeoPoint":
             return (0, _1.geopointConverter)(field.value);
+        case "Link":
+            return (0, _1.linkConverter)(field.value);
         case "Image":
             return (0, _1.imageConverter)(field.value, assets);
         default:

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

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

package/lib/import/converters/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("./GeooPoint"), exports);
 (0, tslib_1.__exportStar)(require("./Image"), exports);
+(0, tslib_1.__exportStar)(require("./Link"), exports);
 (0, tslib_1.__exportStar)(require("./Nestable"), exports);
 (0, tslib_1.__exportStar)(require("./Number"), exports);
 (0, tslib_1.__exportStar)(require("./Select"), exports);

package/lib/import/validators/fields/ImportField.d.ts

@@ -124,6 +124,22 @@ export declare const ImportField: {
                 };
             };
         }) | undefined, unknown> | import("io-ts").Type<{
+            type: "Link";
+            value: ({
+                link_type: "Web";
+                url: string;
+            } & {
+                target?: string;
+            }) | {
+                link_type: "Document";
+                id: string;
+            } | {
+                link_type: "Media";
+                id: string;
+            } | null;
+        }, {
+            link_type: "Document" | "Web" | "Media";
+        } | undefined, unknown> | import("io-ts").Type<{
             type: "Number";
             value: number | null;
         }, number | undefined, unknown> | import("io-ts").Type<{
@@ -148,6 +164,20 @@ export declare const ImportField: {
         }> | import("fp-ts/lib/Either").Right<{
             type: "Number";
             value: number | null;
+        }> | import("fp-ts/lib/Either").Right<{
+            type: "Link";
+            value: ({
+                link_type: "Web";
+                url: string;
+            } & {
+                target?: string;
+            }) | {
+                link_type: "Document";
+                id: string;
+            } | {
+                link_type: "Media";
+                id: string;
+            } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Image";
             value: ({

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

@@ -3,11 +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 ImportContent_1 = require("../ImportContent");
-const io_ts_types_1 = require("io-ts-types");
-const AnyLink = 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 one of `Web`, `Document` or `Media`"),
+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`"),
 });
 const WebLink = t.intersection([
     t.type({
@@ -20,11 +21,15 @@ const WebLink = t.intersection([
 ]);
 const DocumentLink = t.type({
     link_type: t.literal("Document"),
-    id: validators_1.String,
+    id: DocumentId_1.DocumentId,
 });
 const MediaLink = t.type({
     link_type: t.literal("Media"),
     id: validators_1.String,
 });
-const Link = AnyLink.pipe(t.union([WebLink, DocumentLink, MediaLink]));
-exports.ImportLink = (0, ImportContent_1.ImportContent)("Link", (0, validators_1.NullOrElse)(Link));
+const Link = LinkTypeValidator.pipe(t.union([WebLink, DocumentLink, MediaLink]));
+// This is the default value for the link
+const AnyLink = t.type({
+    link_type: t.literal("Any"),
+});
+exports.ImportLink = (0, ImportContent_1.ImportContent)("Link", (0, validators_1.DefaultOrElse)(AnyLink)(Link));

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

@@ -5,11 +5,12 @@ import { ImportDate } from "./Date";
 import { ImportEmbed } from "./Embed";
 import { ImportGeoPoint } from "./GeoPoint";
 import { ImportImage } from "./Image";
+import { ImportLink } from "./Link";
 import { ImportNumber } from "./Number";
 import { ImportSelect } from "./Select";
 import { ImportText } from "./Text";
 import { ImportTimestamp } from "./Timestamp";
-export declare type ImportNestable = ImportBoolean | ImportColor | ImportNumber | ImportSelect | ImportText | ImportDate | ImportTimestamp | ImportEmbed | ImportGeoPoint | ImportImage;
+export declare type ImportNestable = ImportBoolean | ImportColor | ImportNumber | ImportSelect | ImportText | ImportDate | ImportTimestamp | ImportEmbed | ImportLink | ImportGeoPoint | ImportImage;
 export declare const ImportNestable: {
     is(u: unknown): u is ImportNestable;
     decode: (field: NestableWidget) => (content: unknown) => {
@@ -132,6 +133,22 @@ export declare const ImportNestable: {
                 };
             };
         }) | undefined, unknown> | import("io-ts").Type<{
+            type: "Link";
+            value: ({
+                link_type: "Web";
+                url: string;
+            } & {
+                target?: string;
+            }) | {
+                link_type: "Document";
+                id: string;
+            } | {
+                link_type: "Media";
+                id: string;
+            } | null;
+        }, {
+            link_type: "Document" | "Web" | "Media";
+        } | undefined, unknown> | import("io-ts").Type<{
             type: "Number";
             value: number | null;
         }, number | undefined, unknown> | import("io-ts").Type<{
@@ -156,6 +173,20 @@ export declare const ImportNestable: {
         }> | import("fp-ts/lib/Either").Right<{
             type: "Number";
             value: number | null;
+        }> | import("fp-ts/lib/Either").Right<{
+            type: "Link";
+            value: ({
+                link_type: "Web";
+                url: string;
+            } & {
+                target?: string;
+            }) | {
+                link_type: "Document";
+                id: string;
+            } | {
+                link_type: "Media";
+                id: string;
+            } | null;
         }> | import("fp-ts/lib/Either").Right<{
             type: "Image";
             value: ({

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

@@ -7,6 +7,7 @@ const Date_1 = require("./Date");
 const Embed_1 = require("./Embed");
 const GeoPoint_1 = require("./GeoPoint");
 const Image_1 = require("./Image");
+const Link_1 = require("./Link");
 const Number_1 = require("./Number");
 const Select_1 = require("./Select");
 const Text_1 = require("./Text");
@@ -21,6 +22,7 @@ exports.ImportNestable = {
             Date_1.ImportDate.is(u) ||
             Timestamp_1.ImportTimestamp.is(u) ||
             Embed_1.ImportEmbed.is(u) ||
+            Link_1.ImportLink.is(u) ||
             GeoPoint_1.ImportGeoPoint.is(u) ||
             Image_1.ImportImage.is(u));
     },
@@ -42,10 +44,12 @@ exports.ImportNestable = {
                         return Date_1.ImportDate;
                     case "Timestamp":
                         return Timestamp_1.ImportTimestamp;
-                    case "Image":
-                        return Image_1.ImportImage;
                     case "Embed":
                         return Embed_1.ImportEmbed;
+                    case "Link":
+                        return Link_1.ImportLink;
+                    case "Image":
+                        return Image_1.ImportImage;
                     case "GeoPoint":
                         return GeoPoint_1.ImportGeoPoint;
                     default:

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 "./Link";
 export * from "./Nestable";
 export * from "./Number";
 export * from "./Select";

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("./Link"), exports);
 (0, tslib_1.__exportStar)(require("./Nestable"), exports);
 (0, tslib_1.__exportStar)(require("./Number"), exports);
 (0, tslib_1.__exportStar)(require("./Select"), exports);

package/lib/utils/DocumentId.d.ts

@@ -0,0 +1 @@
+export declare const DocumentId: import("io-ts").Type<string, string, unknown>;

package/lib/utils/DocumentId.js

@@ -0,0 +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 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");

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "2.2.0-alpha.3",
+	"version": "2.2.0-alpha.4",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",

package/src/import/converters/fields/nestable/Link.ts

@@ -0,0 +1,33 @@
+import type { LinkContent } from "../../../../content"
+import type { ImportLink } from "../../../validators"
+
+export const linkConverter = (
+	field: ImportLink["value"],
+): LinkContent | undefined => {
+	if (field === null) {
+		return
+	}
+
+	switch (field.link_type) {
+		case "Web":
+			return {
+				value: {
+					url: field.url,
+					target: field.target,
+					__TYPE__: "ExternalLink",
+				},
+				__TYPE__: "LinkContent",
+			}
+		case "Document":
+			return {
+				value: {
+					id: field.id,
+					__TYPE__: "DocumentLink",
+				},
+				__TYPE__: "LinkContent",
+			}
+		// TODO: https://linear.app/prismic/issue/AGE-90/[content-validation-and-error-management]-link-to-media
+		case "Media":
+			return undefined
+	}
+}

package/src/import/converters/fields/nestable/Nestable.ts

@@ -8,6 +8,7 @@ import {
 	embedConverter,
 	geopointConverter,
 	imageConverter,
+	linkConverter,
 	numberConverter,
 	selectConverter,
 	textConverter,
@@ -37,6 +38,8 @@ export function convertNestableWidget(
 			return embedConverter(field.value)
 		case "GeoPoint":
 			return geopointConverter(field.value)
+		case "Link":
+			return linkConverter(field.value)
 		case "Image":
 			return imageConverter(field.value, assets)
 		default:

package/src/import/converters/fields/nestable/index.ts

@@ -4,6 +4,7 @@ export * from "./Date"
 export * from "./Embed"
 export * from "./GeooPoint"
 export * from "./Image"
+export * from "./Link"
 export * from "./Nestable"
 export * from "./Number"
 export * from "./Select"

package/src/import/validators/fields/nestable/Link.ts

@@ -0,0 +1,51 @@
+import type { OutputOf, TypeOf } from "io-ts"
+import * as t from "io-ts"
+import { withMessage } from "io-ts-types"
+
+import { DocumentId } from "../../../../utils/DocumentId"
+import { DefaultOrElse, String } from "../../../../validators"
+import { ImportContent } from "../ImportContent"
+
+const LinkTypeValidator = t.type({
+	link_type: withMessage(
+		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({
+		link_type: t.literal("Web"),
+		url: String,
+	}),
+	t.partial({
+		target: String,
+	}),
+])
+
+const DocumentLink = t.type({
+	link_type: t.literal("Document"),
+	id: DocumentId,
+})
+
+const MediaLink = t.type({
+	link_type: t.literal("Media"),
+	id: String,
+})
+
+const Link = LinkTypeValidator.pipe(t.union([WebLink, DocumentLink, MediaLink]))
+
+// This is the default value for the link
+const AnyLink = t.type({
+	link_type: t.literal("Any"),
+})
+
+export const ImportLink = ImportContent(
+	"Link",
+	DefaultOrElse<
+		TypeOf<typeof AnyLink>,
+		TypeOf<typeof Link>,
+		OutputOf<typeof Link>
+	>(AnyLink)(Link),
+)
+export type ImportLink = TypeOf<typeof ImportLink>

package/src/import/validators/fields/nestable/Nestable.ts

@@ -5,6 +5,7 @@ import { ImportDate } from "./Date"
 import { ImportEmbed } from "./Embed"
 import { ImportGeoPoint } from "./GeoPoint"
 import { ImportImage } from "./Image"
+import { ImportLink } from "./Link"
 import { ImportNumber } from "./Number"
 import { ImportSelect } from "./Select"
 import { ImportText } from "./Text"
@@ -19,6 +20,7 @@ export type ImportNestable =
 	| ImportDate
 	| ImportTimestamp
 	| ImportEmbed
+	| ImportLink
 	| ImportGeoPoint
 	| ImportImage
 
@@ -33,6 +35,7 @@ export const ImportNestable = {
 			ImportDate.is(u) ||
 			ImportTimestamp.is(u) ||
 			ImportEmbed.is(u) ||
+			ImportLink.is(u) ||
 			ImportGeoPoint.is(u) ||
 			ImportImage.is(u)
 		)
@@ -55,10 +58,12 @@ export const ImportNestable = {
 						return ImportDate
 					case "Timestamp":
 						return ImportTimestamp
-					case "Image":
-						return ImportImage
 					case "Embed":
 						return ImportEmbed
+					case "Link":
+						return ImportLink
+					case "Image":
+						return ImportImage
 					case "GeoPoint":
 						return ImportGeoPoint
 					default:

package/src/import/validators/fields/nestable/index.ts

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

package/src/utils/DocumentId.ts

@@ -0,0 +1,9 @@
+import { withMessage } from "io-ts-types"
+
+import { String } from "../validators"
+import { refineType } from "../validators/function"
+
+export const DocumentId = withMessage(
+	refineType(String, "DocumentId", (s) => s.length === 16),
+	() => "DocumentId must be a 16 character string",
+)