@prismicio/types-internal 2.2.0-alpha.10 → 2.2.0-alpha.12

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceType.ts

@@ -0,0 +1,45 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import * as t from "io-ts"
+
+import { SharedSlice as SharedSliceCustomType } from "../../../../../../customtypes"
+import { NonEmptyString } from "../../../../../../validators"
+import { findSlice } from "../utils"
+
+export type SharedSliceType = {
+	slice_type: string
+	data: SharedSliceCustomType
+}
+
+/**
+ * slice_type - the validated slice_type
+ * slice - SharedSlice custom type data matching the slice_type. We return it alongside the validated slice_type, because it is needed to decode the 'variation' field in the SharedSlice (see SharedSliceVariation.ts)
+ */
+const SharedSliceTypeShape = t.type({
+	slice_type: NonEmptyString,
+	slice: SharedSliceCustomType,
+})
+
+/**
+ * Builds the decoder for the 'slice_type' field in the SharedSlice. Alongside the decoded 'slice_type' it also returns the SharedSlice data matching the slice_type.
+ * @param slices all the SharedSlices from the custom type
+ */
+export const SharedSliceType = (slices: SharedSliceCustomType[]) =>
+	new t.Type<SharedSliceType, string, unknown>(
+		"slice_type",
+		(u): u is SharedSliceType => SharedSliceTypeShape.is(u),
+		(u, c) =>
+			pipe(
+				NonEmptyString.validate(u, c),
+				E.chain((slice_type) =>
+					pipe(
+						findSlice(slices)(slice_type),
+						E.fold(
+							(err) => t.failure(u, c, err),
+							(data) => t.success({ slice_type, data }),
+						),
+					),
+				),
+			),
+		({ slice_type }) => slice_type,
+	)

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/SharedSliceVariation.ts

@@ -0,0 +1,45 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import * as t from "io-ts"
+
+import { SharedSlice, Variation } from "../../../../../../customtypes"
+import { NonEmptyString } from "../../../../../../validators"
+import { findSliceVariation } from "../utils"
+
+export type SharedSliceVariation = {
+	variation: string
+	data: Variation
+}
+
+/**
+ * variation - the validated variation of the slice
+ * data - Variation data matching the variation. We return it alongside the validated variation, because it is needed to decode the 'primary' and 'items' fields in the SharedSlice.
+ */
+const SharedSliceVariationShape = t.type({
+	variation: NonEmptyString,
+	data: Variation,
+})
+
+/**
+ * Builds the decoder for the 'variation' field in the SharedSlice. Alongside the decoded 'variation' it also returns the Variation data matching the variation custom type.
+ * @param slice SharedSlice from the custom type
+ */
+export const SharedSliceVariation = (slice: SharedSlice) =>
+	new t.Type<SharedSliceVariation, string, unknown>(
+		"variation",
+		(u): u is SharedSliceVariation => SharedSliceVariationShape.is(u),
+		(u, c) =>
+			pipe(
+				NonEmptyString.validate(u, c),
+				E.chain((variation) =>
+					pipe(
+						findSliceVariation(slice)(variation),
+						E.fold(
+							(err) => t.failure(u, c, err),
+							(data) => t.success({ variation, data }),
+						),
+					),
+				),
+			),
+		({ variation }) => variation,
+	)

package/src/import/validators/fields/ImportSlices/SharedSlice/fields/index.ts

@@ -0,0 +1,5 @@
+export * from "./OptionalSharedSliceId"
+export * from "./SharedSliceContent"
+export * from "./SharedSliceId"
+export * from "./SharedSliceType"
+export * from "./SharedSliceVariation"

package/src/import/validators/fields/ImportSlices/SharedSlice/index.ts

@@ -0,0 +1,3 @@
+export * from "./errors"
+export * from "./fields"
+export * from "./SharedSlice"

package/src/import/validators/fields/ImportSlices/SharedSlice/utils.ts

@@ -0,0 +1,21 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+
+import type { SharedSlice as SharedSliceCustomType } from "../../../../../customtypes"
+import type { Variation } from "../../../../../customtypes"
+import { SharedSliceErrors } from "./errors"
+
+export const findSlice =
+	(slices: SharedSliceCustomType[]) => (sliceId: string) =>
+		pipe(
+			slices.find((slice) => slice.id === sliceId),
+			E.fromNullable(SharedSliceErrors.SliceTypeNotFound(sliceId)),
+		)
+
+export const findSliceVariation =
+	(slice: SharedSliceCustomType) =>
+	(variation: string): E.Either<string, Variation> =>
+		pipe(
+			slice.variations.find((v) => v.id === variation),
+			E.fromNullable(SharedSliceErrors.VariationNotFound(variation, slice.id)),
+		)

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

@@ -0,0 +1 @@
+export * from "./ImportSlices"

package/src/import/validators/fields/ImportSlices/utils.ts

@@ -0,0 +1,43 @@
+import * as A from "fp-ts/Array"
+import { pipe } from "fp-ts/function"
+import * as O from "fp-ts/Option"
+
+import {
+	SharedSlice as SharedSliceCustomType,
+	StaticSlices,
+} from "../../../../customtypes"
+import type { SharedSlice, SharedSliceId } from "./SharedSlice"
+
+// Extracts all supported slices from the static slices object
+// For now we only support the SharedSlice, if we want to support other slices in the future, we have to add them here
+export const extractSupportedSlices = (
+	staticSlices: StaticSlices,
+): SharedSliceCustomType[] =>
+	pipe(
+		Object.values(staticSlices.config?.choices ?? {}).map((slice) =>
+			pipe(SharedSliceCustomType.decode(slice), O.fromEither),
+		),
+		A.compact,
+	)
+
+export const findImportSharedSliceDuplicateIds = (
+	slices: SharedSlice[],
+): SharedSliceId[] => {
+	const duplicatesMap = slices.reduce((acc, { id }) => {
+		if (id) {
+			const currentNumOfDuplicates = acc[id] ?? 0
+			return {
+				...acc,
+				[id]: acc[id] === undefined ? 0 : currentNumOfDuplicates + 1,
+			}
+		}
+		return acc
+	}, {} as Record<SharedSliceId, number>)
+
+	return Object.entries(duplicatesMap).flatMap(([id, numOfDuplicates]) => {
+		if (numOfDuplicates > 0) {
+			return [id]
+		}
+		return []
+	})
+}

package/src/utils/io-ts.ts

@@ -0,0 +1,29 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import * as RA from "fp-ts/ReadonlyArray"
+import type { Semigroup } from "fp-ts/Semigroup"
+import type { Errors, Validation } from "io-ts"
+
+/*
+ * 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: Semigroup<Errors> = {
+	concat: (a: Errors, b: Errors) => [...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.
+ */
+export const combineValidationResults = <T>(
+	validationResults: readonly Validation<T>[],
+): Validation<readonly T[]> =>
+	pipe(
+		validationResults,
+		RA.traverse(E.getApplicativeValidation(validationErrorsSemigroup))(
+			(validation) => validation,
+		),
+	)

package/src/validators/BasicTypes.ts

@@ -51,3 +51,8 @@ export const AnyObject = withMessage(
 	t.record(t.string, t.unknown),
 	() => "The value must be an object",
 )
+
+export const AnyArray = withMessage(
+	t.array(t.unknown),
+	() => "The value must be an array",
+)

package/src/validators/NonEmptyString.ts

@@ -1,9 +1,9 @@
 import * as t from "io-ts"
+import { withMessage } from "io-ts-types"
 
 import { refineType } from "./function"
 
-export default refineType(
-	t.string,
-	"nonEmptyString",
-	(s) => s.trim().length > 0,
+export default withMessage(
+	refineType(t.string, "nonEmptyString", (s) => s.trim().length > 0),
+	() => "The value must be a non-empty string",
 )

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

@@ -1,62 +0,0 @@
-import * as t from "io-ts";
-export declare type ImageField = {
-    id: string;
-    edit: {
-        x: number;
-        y: number;
-        zoom: number;
-        background?: string;
-    };
-    dimensions: {
-        width?: number;
-        height?: number;
-    };
-    credit?: string | null;
-    alt?: string | null;
-};
-declare type ImageFieldWithThumbnails = ImageField & {
-    thumbnails: Record<string, ImageField>;
-};
-declare const ImageFieldWithThumbnails: (field?: ({
-    type: "Image";
-} & {
-    fieldset?: string | null | undefined;
-    config?: {
-        label?: string | null | undefined;
-        placeholder?: string;
-        constraint?: {
-            width?: number | null;
-            height?: number | null;
-        };
-        thumbnails?: readonly ({
-            name: string;
-        } & {
-            width?: number | null;
-            height?: number | null;
-        })[];
-    };
-}) | undefined) => t.Type<ImageFieldWithThumbnails, ImageFieldWithThumbnails, unknown>;
-export declare const ImportImage: (field?: ({
-    type: "Image";
-} & {
-    fieldset?: string | null | undefined;
-    config?: {
-        label?: string | null | undefined;
-        placeholder?: string;
-        constraint?: {
-            width?: number | null;
-            height?: number | null;
-        };
-        thumbnails?: readonly ({
-            name: string;
-        } & {
-            width?: number | null;
-            height?: number | null;
-        })[];
-    };
-}) | undefined) => t.Type<{
-    type: "Image";
-    value: ImageFieldWithThumbnails | null;
-}, ImageFieldWithThumbnails | undefined, unknown>;
-export declare type ImportImage = t.TypeOf<ReturnType<typeof ImportImage>>;
-export {};

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

@@ -1,76 +0,0 @@
-"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/lib/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const validators_1 = require("../../../../validators");
-const BasicTypes_1 = require("../../../../validators/BasicTypes");
-const ImportContent_1 = require("../ImportContent");
-const ImageFieldValidator = BasicTypes_1.AnyObject.pipe(t.intersection([
-    t.type({
-        id: BasicTypes_1.String,
-    }),
-    t.partial({
-        dimensions: BasicTypes_1.AnyObject.pipe(t.partial({
-            width: BasicTypes_1.Number,
-            height: BasicTypes_1.Number,
-        })),
-        edit: BasicTypes_1.AnyObject.pipe(t.partial({
-            x: BasicTypes_1.Number,
-            y: BasicTypes_1.Number,
-            zoom: BasicTypes_1.Number,
-            background: BasicTypes_1.String,
-        })),
-        credit: BasicTypes_1.StringOrNull,
-        alt: BasicTypes_1.StringOrNull,
-    }),
-]));
-const ThumbnailsValidator = t.record(t.string, ImageFieldValidator);
-const encodeImageField = (image, mainImage, constraints) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
-    const background = (_a = image === null || image === void 0 ? void 0 : image.edit) === null || _a === void 0 ? void 0 : _a.background;
-    const width = (_d = (_b = constraints === null || constraints === void 0 ? void 0 : constraints.width) !== null && _b !== void 0 ? _b : (_c = image === null || image === void 0 ? void 0 : image.dimensions) === null || _c === void 0 ? void 0 : _c.width) !== null && _d !== void 0 ? _d : (_e = mainImage.dimensions) === null || _e === void 0 ? void 0 : _e.width;
-    const height = (_h = (_f = constraints === null || constraints === void 0 ? void 0 : constraints.height) !== null && _f !== void 0 ? _f : (_g = image === null || image === void 0 ? void 0 : image.dimensions) === null || _g === void 0 ? void 0 : _g.height) !== null && _h !== void 0 ? _h : (_j = mainImage.dimensions) === null || _j === void 0 ? void 0 : _j.height;
-    const alt = image === null || image === void 0 ? void 0 : image.alt;
-    const credit = image === null || image === void 0 ? void 0 : image.credit;
-    return {
-        id: (_k = image === null || image === void 0 ? void 0 : image.id) !== null && _k !== void 0 ? _k : mainImage === null || mainImage === void 0 ? void 0 : mainImage.id,
-        edit: {
-            x: (_m = (_l = image === null || image === void 0 ? void 0 : image.edit) === null || _l === void 0 ? void 0 : _l.x) !== null && _m !== void 0 ? _m : 0,
-            y: (_p = (_o = image === null || image === void 0 ? void 0 : image.edit) === null || _o === void 0 ? void 0 : _o.y) !== null && _p !== void 0 ? _p : 0,
-            zoom: (_r = (_q = image === null || image === void 0 ? void 0 : image.edit) === null || _q === void 0 ? void 0 : _q.zoom) !== null && _r !== void 0 ? _r : 1,
-            ...(background !== undefined ? { background } : {}),
-        },
-        dimensions: {
-            ...(width !== undefined ? { width } : {}),
-            ...(height !== undefined ? { height } : {}),
-        },
-        ...(alt !== undefined ? { alt } : {}),
-        ...(credit !== undefined ? { credit } : {}),
-    };
-};
-const encodeThumbnails = (mainImage, thumbnails, field) => {
-    var _a, _b, _c;
-    return (_c = (_b = (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.thumbnails) === null || _b === void 0 ? void 0 : _b.reduce((acc, thumbnail) => ({
-        ...acc,
-        [thumbnail.name]: encodeImageField(thumbnails[thumbnail.name], mainImage, thumbnail),
-    }), {})) !== null && _c !== void 0 ? _c : {};
-};
-const ImageFieldWithThumbnails = (field) => new t.Type("ImageFieldWithThumbnails", (u) => ImageFieldValidator.is(u) &&
-    "thumbnails" in u &&
-    ThumbnailsValidator.is(u["thumbnails"]), (u, ctx) => {
-    return (0, function_1.pipe)(ImageFieldValidator.validate(u, ctx), (0, Either_1.chain)((mainImage) => {
-        const { id, dimensions, edit, credit, alt, ...maybeThumbnails } = mainImage;
-        return (0, function_1.pipe)(ThumbnailsValidator.validate(maybeThumbnails, ctx), (0, Either_1.map)((thumbnails) => {
-            var _a;
-            return ({
-                ...encodeImageField(mainImage, mainImage, (_a = field === null || field === void 0 ? void 0 : field.config) === null || _a === void 0 ? void 0 : _a.constraint),
-                thumbnails: encodeThumbnails(mainImage, thumbnails, field),
-            });
-        }));
-    }));
-}, t.identity);
-const ImportImage = (field) => (0, ImportContent_1.ImportContent)("Image", (0, validators_1.NullOrElse)(ImageFieldWithThumbnails(field)));
-exports.ImportImage = ImportImage;