@prismicio/types-internal 2.2.0-alpha.5 → 2.2.0-alpha.7

package/lib/common/Embed.d.ts

@@ -0,0 +1,16 @@
+export declare 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 declare type EmbedUrl = string;
+export declare const getEmbedOrThrow: (embeds: Record<string, Embed>) => (embedUrl: string) => Embed;

package/lib/common/Embed.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEmbedOrThrow = void 0;
+const getEmbedOrThrow = (embeds) => (embedUrl) => {
+    const embed = embeds[embedUrl];
+    if (!embed)
+        throw new Error(`Missing embed with url '${embedUrl}'`);
+    return embed;
+};
+exports.getEmbedOrThrow = getEmbedOrThrow;

package/lib/common/index.d.ts

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

package/lib/common/index.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./Asset"), exports);
+(0, tslib_1.__exportStar)(require("./Embed"), exports);
 (0, tslib_1.__exportStar)(require("./WidgetKey"), exports);

package/lib/import/converters/Document.d.ts

@@ -1,4 +1,5 @@
 import type { Asset } from "../../common";
+import type { Embed } from "../../common/Embed";
 import type { Document } from "../../content";
 import type { ImportDocument } from "../validators";
-export declare function convertImportToContent(document: ImportDocument, assets: Record<string, Asset>): Document;
+export declare function convertImportToContent(document: ImportDocument, assets: Record<string, Asset>, embeds: Record<string, Embed>): Document;

package/lib/import/converters/Document.js

@@ -2,18 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertImportToContent = void 0;
 const fields_1 = require("./fields");
-function convertImportToContent(document, assets) {
+function convertImportToContent(document, assets, embeds) {
     return Object.entries(document).reduce((acc, [fieldKey, fieldValue]) => {
-        const newFieldValue = convertWidget(fieldValue, assets);
+        const newFieldValue = convertWidget(fieldValue, assets, embeds);
         return newFieldValue ? { ...acc, [fieldKey]: newFieldValue } : acc;
     }, {});
 }
 exports.convertImportToContent = convertImportToContent;
-function convertWidget(field, assets) {
+function convertWidget(field, assets, embeds) {
     switch (field.type) {
         case "UID":
             return (0, fields_1.uidConverter)(field.value);
         default:
-            return (0, fields_1.convertNestableWidget)(field, assets);
+            return (0, fields_1.convertNestableWidget)(field, assets, embeds);
     }
 }

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

@@ -1,3 +1,4 @@
+import type { Embed } from "../../../../common";
 import type { EmbedContent } from "../../../../content";
 import type { ImportEmbed } from "../../../validators";
-export declare const embedConverter: (field: ImportEmbed["value"]) => EmbedContent | undefined;
+export declare const embedConverter: (field: ImportEmbed["value"], embeds: Record<string, Embed>) => EmbedContent | undefined;

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

@@ -1,13 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.embedConverter = void 0;
-const embedConverter = (field) => {
+const common_1 = require("../../../../common");
+const Objects_1 = require("../../../../utils/Objects");
+const embedConverter = (field, embeds) => {
     if (field === null)
         return;
-    return {
-        ...field,
+    const embed = (0, common_1.getEmbedOrThrow)(embeds)(field.embed_url);
+    return (0, Objects_1.withOptionals)({
+        embed_url: field.embed_url,
+        type: embed.type,
+        all: {
+            embed_url: field.embed_url,
+            ...embed,
+        },
         __TYPE__: "EmbedContent",
-    };
-    return;
+    }, [
+        ["version", embed.version],
+        ["title", embed.title],
+        ["author_name", embed.author_name],
+        ["author_url", embed.author_url],
+        ["provider_name", embed.provider_name],
+        ["provider_url", embed.provider_url],
+        ["cache_age", embed.cache_age],
+        ["thumbnail_url", embed.thumbnail_url],
+        ["thumbnail_width", embed.thumbnail_width],
+        ["thumbnail_height", embed.thumbnail_height],
+        ["html", embed.html],
+    ]);
 };
 exports.embedConverter = embedConverter;

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

@@ -1,4 +1,5 @@
 import type { Asset } from "../../../../common";
+import type { Embed } from "../../../../common/Embed";
 import type { WidgetContent } from "../../../../content";
 import type { ImportNestable } from "../../../validators";
-export declare function convertNestableWidget(field: ImportNestable, assets: Record<string, Asset>): WidgetContent | undefined;
+export declare function convertNestableWidget(field: ImportNestable, assets: Record<string, Asset>, embeds: Record<string, Embed>): WidgetContent | undefined;

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertNestableWidget = void 0;
 const _1 = require(".");
-function convertNestableWidget(field, assets) {
+function convertNestableWidget(field, assets, embeds) {
     switch (field.type) {
         case "Boolean":
             return (0, _1.booleanConverter)(field.value);
@@ -19,7 +19,7 @@ function convertNestableWidget(field, assets) {
         case "Timestamp":
             return (0, _1.timestampConverter)(field.value);
         case "Embed":
-            return (0, _1.embedConverter)(field.value);
+            return (0, _1.embedConverter)(field.value, embeds);
         case "GeoPoint":
             return (0, _1.geopointConverter)(field.value);
         case "Link":

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

@@ -16,42 +16,12 @@ export declare const ImportField: {
             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;
@@ -219,24 +189,9 @@ export declare const ImportField: {
             } | 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/Embed.d.ts

@@ -1,27 +1,10 @@
 import * as t from "io-ts";
-declare const EmbedProto: t.ExactC<t.IntersectionC<[t.TypeC<{
-    embed_url: t.Type<string, string, unknown>;
-    type: t.StringC;
-}>, t.PartialC<{
-    version: t.UnionC<[t.StringC, t.NumberC, t.NullC]>;
-    title: t.StringC;
-    author_name: t.UnionC<[t.StringC, t.NullC]>;
-    author_url: t.UnionC<[t.StringC, t.NullC]>;
-    provider_name: t.UnionC<[t.StringC, t.NullC]>;
-    provider_url: t.UnionC<[t.StringC, t.NullC]>;
-    cache_age: t.UnionC<[t.StringC, t.NumberC, t.NullC]>;
-    thumbnail_url: t.UnionC<[t.StringC, t.NullC]>;
-    thumbnail_width: t.UnionC<[t.NumberC, t.NullC]>;
-    thumbnail_height: t.UnionC<[t.NumberC, t.NullC]>;
-    html: t.UnionC<[t.StringC, t.NullC]>;
-}>]>>;
-declare type EmbedProto = t.TypeOf<typeof EmbedProto>;
-declare type Embed = EmbedProto & {
-    all: unknown;
-};
 export declare const ImportEmbed: t.Type<{
     type: "Embed";
-    value: Embed | null;
-}, Embed | undefined, unknown>;
+    value: {
+        embed_url: string;
+    } | null;
+}, {
+    embed_url: string;
+} | undefined, unknown>;
 export declare type ImportEmbed = t.TypeOf<typeof ImportEmbed>;
-export {};

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

@@ -2,12 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImportEmbed = void 0;
 const tslib_1 = require("tslib");
-const Either = (0, tslib_1.__importStar)(require("fp-ts/lib/Either"));
+const Either = (0, tslib_1.__importStar)(require("fp-ts/Either"));
 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");
 const validators_1 = require("../../../../validators");
-const BasicTypes_1 = require("../../../../validators/BasicTypes");
 const ImportContent_1 = require("../ImportContent");
 function isValidHttpUrl(param) {
     try {
@@ -29,26 +27,10 @@ const EmbedUrl = new t.Type("EmbedUrl", (u) => isValidHttpUrl(u), (u, c) => {
         return t.failure(u, c, "The value must be a valid http/https url");
     }
 }, t.identity);
-const EmbedProto = t.exact(t.intersection([
-    t.type({
-        embed_url: EmbedUrl,
-        type: BasicTypes_1.String,
-    }),
-    t.partial({
-        version: (0, io_ts_types_1.withMessage)(t.union([t.string, t.number, t.null]), () => "The value must be either string, number or null"),
-        title: BasicTypes_1.String,
-        author_name: BasicTypes_1.StringOrNull,
-        author_url: BasicTypes_1.StringOrNull,
-        provider_name: BasicTypes_1.StringOrNull,
-        provider_url: BasicTypes_1.StringOrNull,
-        cache_age: (0, io_ts_types_1.withMessage)(t.union([t.string, t.number, t.null]), () => "The value must be either string, number or null"),
-        thumbnail_url: BasicTypes_1.StringOrNull,
-        thumbnail_width: BasicTypes_1.NumberOrNull,
-        thumbnail_height: BasicTypes_1.NumberOrNull,
-        html: BasicTypes_1.StringOrNull,
-    }),
-]));
-const embedValue = new t.Type("ImportEmbedValue", (u) => EmbedProto.is(u) && "all" in u, (u) => {
-    return (0, function_1.pipe)(EmbedProto.decode(u), Either.map((parsed) => ({ ...parsed, all: u })));
+const EmbedProto = t.type({
+    embed_url: EmbedUrl,
+});
+const Embed = new t.Type("ImportEmbedValue", (u) => EmbedProto.is(u), (u) => {
+    return (0, function_1.pipe)(EmbedProto.decode(u), Either.map((parsed) => ({ embed_url: parsed.embed_url })));
 }, t.identity);
-exports.ImportEmbed = (0, ImportContent_1.ImportContent)("Embed", (0, validators_1.EmptyObjectOrElse)(embedValue));
+exports.ImportEmbed = (0, ImportContent_1.ImportContent)("Embed", (0, validators_1.EmptyObjectOrElse)(Embed));

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;
@@ -228,24 +198,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/package.json

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

package/src/common/Embed.ts

@@ -0,0 +1,23 @@
+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 type EmbedUrl = string
+
+export const getEmbedOrThrow =
+	(embeds: Record<string, Embed>) => (embedUrl: string) => {
+		const embed = embeds[embedUrl]
+		if (!embed) throw new Error(`Missing embed with url '${embedUrl}'`)
+		return embed
+	}

package/src/common/index.ts

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

package/src/import/converters/Document.ts

@@ -1,4 +1,5 @@
 import type { Asset } from "../../common"
+import type { Embed } from "../../common/Embed"
 import type { Document, WidgetContent } from "../../content"
 import type { ImportDocument } from "../validators"
 import type { ImportField } from "../validators/fields/ImportField"
@@ -7,10 +8,11 @@ import { convertNestableWidget, uidConverter } from "./fields"
 export function convertImportToContent(
 	document: ImportDocument,
 	assets: Record<string, Asset>,
+	embeds: Record<string, Embed>,
 ): Document {
 	return Object.entries(document).reduce<Document>(
 		(acc, [fieldKey, fieldValue]) => {
-			const newFieldValue = convertWidget(fieldValue, assets)
+			const newFieldValue = convertWidget(fieldValue, assets, embeds)
 			return newFieldValue ? { ...acc, [fieldKey]: newFieldValue } : acc
 		},
 		{},
@@ -20,11 +22,12 @@ export function convertImportToContent(
 function convertWidget(
 	field: ImportField,
 	assets: Record<string, Asset>,
+	embeds: Record<string, Embed>,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "UID":
 			return uidConverter(field.value)
 		default:
-			return convertNestableWidget(field, assets)
+			return convertNestableWidget(field, assets, embeds)
 	}
 }

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

@@ -1,15 +1,37 @@
+import type { Embed } from "../../../../common"
+import { getEmbedOrThrow } from "../../../../common"
 import type { EmbedContent } from "../../../../content"
+import { withOptionals } from "../../../../utils/Objects"
 import type { ImportEmbed } from "../../../validators"
 
 export const embedConverter = (
 	field: ImportEmbed["value"],
+	embeds: Record<string, Embed>,
 ): EmbedContent | undefined => {
 	if (field === null) return
-
-	return {
-		...field,
-		__TYPE__: "EmbedContent",
-	}
-
-	return
+	const embed = getEmbedOrThrow(embeds)(field.embed_url)
+	return withOptionals<EmbedContent>(
+		{
+			embed_url: field.embed_url,
+			type: embed.type,
+			all: {
+				embed_url: field.embed_url,
+				...embed,
+			},
+			__TYPE__: "EmbedContent",
+		},
+		[
+			["version", embed.version],
+			["title", embed.title],
+			["author_name", embed.author_name],
+			["author_url", embed.author_url],
+			["provider_name", embed.provider_name],
+			["provider_url", embed.provider_url],
+			["cache_age", embed.cache_age],
+			["thumbnail_url", embed.thumbnail_url],
+			["thumbnail_width", embed.thumbnail_width],
+			["thumbnail_height", embed.thumbnail_height],
+			["html", embed.html],
+		],
+	)
 }

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

@@ -1,4 +1,5 @@
 import type { Asset } from "../../../../common"
+import type { Embed } from "../../../../common/Embed"
 import type { WidgetContent } from "../../../../content"
 import type { ImportNestable } from "../../../validators"
 import {
@@ -18,6 +19,7 @@ import {
 export function convertNestableWidget(
 	field: ImportNestable,
 	assets: Record<string, Asset>,
+	embeds: Record<string, Embed>,
 ): WidgetContent | undefined {
 	switch (field.type) {
 		case "Boolean":
@@ -35,7 +37,7 @@ export function convertNestableWidget(
 		case "Timestamp":
 			return timestampConverter(field.value)
 		case "Embed":
-			return embedConverter(field.value)
+			return embedConverter(field.value, embeds)
 		case "GeoPoint":
 			return geopointConverter(field.value)
 		case "Link":

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

@@ -1,14 +1,8 @@
-import * as Either from "fp-ts/lib/Either"
+import * as Either from "fp-ts/Either"
 import { pipe } from "fp-ts/lib/function"
 import * as t from "io-ts"
-import { withMessage } from "io-ts-types"
 
 import { EmptyObjectOrElse } from "../../../../validators"
-import {
-	NumberOrNull,
-	String,
-	StringOrNull,
-} from "../../../../validators/BasicTypes"
 import { ImportContent } from "../ImportContent"
 
 type URL = string
@@ -38,49 +32,23 @@ const EmbedUrl = new t.Type<URL, URL, unknown>(
 	t.identity,
 )
 
-const EmbedProto = t.exact(
-	t.intersection([
-		t.type({
-			embed_url: EmbedUrl,
-			type: String,
-		}),
-		t.partial({
-			version: withMessage(
-				t.union([t.string, t.number, t.null]),
-				() => "The value must be either string, number or null",
-			),
-			title: String,
-			author_name: StringOrNull,
-			author_url: StringOrNull,
-			provider_name: StringOrNull,
-			provider_url: StringOrNull,
-			cache_age: withMessage(
-				t.union([t.string, t.number, t.null]),
-				() => "The value must be either string, number or null",
-			),
-			thumbnail_url: StringOrNull,
-			thumbnail_width: NumberOrNull,
-			thumbnail_height: NumberOrNull,
-			html: StringOrNull,
-		}),
-	]),
-)
+const EmbedProto = t.type({
+	embed_url: EmbedUrl,
+})
 type EmbedProto = t.TypeOf<typeof EmbedProto>
 
-type Embed = EmbedProto & {
-	all: unknown
-}
-const embedValue = new t.Type<Embed>(
+type Embed = EmbedProto
+const Embed = new t.Type<Embed>(
 	"ImportEmbedValue",
-	(u: unknown): u is Embed => EmbedProto.is(u) && "all" in u,
+	(u: unknown): u is Embed => EmbedProto.is(u),
 	(u: unknown) => {
 		return pipe(
 			EmbedProto.decode(u),
-			Either.map((parsed) => ({ ...parsed, all: u })),
+			Either.map((parsed) => ({ embed_url: parsed.embed_url })),
 		)
 	},
 	t.identity,
 )
 
-export const ImportEmbed = ImportContent("Embed", EmptyObjectOrElse(embedValue))
+export const ImportEmbed = ImportContent("Embed", EmptyObjectOrElse(Embed))
 export type ImportEmbed = t.TypeOf<typeof ImportEmbed>