@prismicio/types-internal 2.2.0-alpha.2 → 2.2.0-alpha.21

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/HyperlinkSpan.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HyperlinkSpan = exports.HyperlinkSpanType = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const function_1 = require("../../../../../../../validators/function");
+const Link_1 = require("../../../Link");
+const SpanLocation_1 = require("./SpanLocation");
+exports.HyperlinkSpanType = t.literal("hyperlink");
+exports.HyperlinkSpan = t.exact(t.intersection([
+    t.type({
+        type: exports.HyperlinkSpanType,
+    }),
+    SpanLocation_1.SpanLocation,
+    (0, function_1.withCustomError)(t.type({
+        data: Link_1.Link,
+    }), () => "Hyperlink span must contain a 'data' field with link data"),
+]));

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/SpanLocation.d.ts

@@ -0,0 +1,5 @@
+import * as t from "io-ts";
+export declare const SpanLocation: t.TypeC<{
+    start: t.NumberC;
+    end: t.NumberC;
+}>;

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/SpanLocation.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpanLocation = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const validators_1 = require("../../../../../../../validators");
+exports.SpanLocation = t.type({
+    start: validators_1.Number,
+    end: validators_1.Number,
+});

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/TextSpan.d.ts

@@ -0,0 +1,17 @@
+import * as t from "io-ts";
+export declare const TextSpanType: t.KeyofC<{
+    strong: null;
+    em: null;
+    label: null;
+}>;
+export declare const TextSpan: t.ExactC<t.IntersectionC<[t.TypeC<{
+    type: t.KeyofC<{
+        strong: null;
+        em: null;
+        label: null;
+    }>;
+}>, t.TypeC<{
+    start: t.NumberC;
+    end: t.NumberC;
+}>]>>;
+export declare type TextSpan = t.TypeOf<typeof TextSpan>;

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/TextSpan.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextSpan = exports.TextSpanType = void 0;
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const SpanLocation_1 = require("./SpanLocation");
+const TextSpanTypes = {
+    Strong: "strong",
+    Em: "em",
+    Label: "label",
+};
+exports.TextSpanType = t.keyof({
+    [TextSpanTypes.Strong]: null,
+    [TextSpanTypes.Em]: null,
+    [TextSpanTypes.Label]: null,
+});
+exports.TextSpan = t.exact(t.intersection([
+    t.type({
+        type: exports.TextSpanType,
+    }),
+    SpanLocation_1.SpanLocation,
+]));

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./HyperlinkSpan";
+export * from "./TextSpan";

package/lib/import/validators/fields/nestable/ImportRichText/blocks/spans/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./HyperlinkSpan"), exports);
+(0, tslib_1.__exportStar)(require("./TextSpan"), exports);

package/lib/import/validators/fields/nestable/ImportRichText/index.d.ts

@@ -0,0 +1,2 @@
+export { ImportBlock } from "./ImportBlock";
+export { ImportRichText } from "./ImportRichText";

package/lib/import/validators/fields/nestable/ImportRichText/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportRichText = exports.ImportBlock = void 0;
+var ImportBlock_1 = require("./ImportBlock");
+Object.defineProperty(exports, "ImportBlock", { enumerable: true, get: function () { return ImportBlock_1.ImportBlock; } });
+var ImportRichText_1 = require("./ImportRichText");
+Object.defineProperty(exports, "ImportRichText", { enumerable: true, get: function () { return ImportRichText_1.ImportRichText; } });

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

@@ -1,5 +1,37 @@
 import type { TypeOf } from "io-ts";
 import * as t from "io-ts";
+declare const WebLink: t.ExactC<t.IntersectionC<[t.TypeC<{
+    link_type: t.LiteralC<"Web">;
+    url: t.StringC;
+}>, t.PartialC<{
+    target: t.StringC;
+}>]>>;
+export declare type WebLink = t.TypeOf<typeof WebLink>;
+declare const DocumentLink: t.ExactC<t.TypeC<{
+    link_type: t.LiteralC<"Document">;
+    id: t.Type<string, string, unknown>;
+}>>;
+export declare type DocumentLink = t.TypeOf<typeof DocumentLink>;
+declare const MediaLink: t.ExactC<t.TypeC<{
+    link_type: t.LiteralC<"Media">;
+    id: t.StringC;
+}>>;
+export declare type MediaLink = t.TypeOf<typeof MediaLink>;
+export declare const Link: t.Type<({
+    link_type: "Web";
+    url: string;
+} & {
+    target?: string;
+}) | {
+    link_type: "Document";
+    id: string;
+} | {
+    link_type: "Media";
+    id: string;
+}, {
+    link_type: "Document" | "Web" | "Media";
+}, unknown>;
+export declare type Link = TypeOf<typeof Link>;
 export declare const ImportLink: t.Type<{
     type: "Link";
     value: ({
@@ -18,3 +50,4 @@ export declare const ImportLink: t.Type<{
     link_type: "Document" | "Web" | "Media";
 } | undefined, unknown>;
 export declare type ImportLink = TypeOf<typeof ImportLink>;
+export {};

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

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImportLink = void 0;
+exports.ImportLink = exports.Link = void 0;
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
+const DocumentId_1 = require("../../../../utils/DocumentId");
 const validators_1 = require("../../../../validators");
+const function_1 = require("../../../../validators/function");
 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, function_1.withCustomError)(t.union([t.literal("Web"), t.literal("Document"), t.literal("Media")]), () => "The value must be `Web`, `Document` or `Media`"),
 });
-const WebLink = t.intersection([
+const WebLink = t.exact(t.intersection([
     t.type({
         link_type: t.literal("Web"),
         url: validators_1.String,
@@ -17,14 +18,18 @@ const WebLink = t.intersection([
     t.partial({
         target: validators_1.String,
     }),
-]);
-const DocumentLink = t.type({
+]));
+const DocumentLink = t.strict({
     link_type: t.literal("Document"),
-    id: validators_1.String,
+    id: DocumentId_1.DocumentId,
 });
-const MediaLink = t.type({
+const MediaLink = t.strict({
     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));
+exports.Link = LinkTypeValidator.pipe(t.union([WebLink, DocumentLink, MediaLink]));
+// This is the default value for the link
+const AnyLink = t.strict({
+    link_type: t.literal("Any"),
+});
+exports.ImportLink = (0, ImportContent_1.ImportContent)("Link", (0, validators_1.DefaultOrElse)(AnyLink)(exports.Link));

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

@@ -1,14 +1,17 @@
 import type { NestableWidget } from "../../../../customtypes";
-import { ImportBoolean } from ".";
+import { ImportBoolean } from "./Boolean";
 import { ImportColor } from "./Color";
 import { ImportDate } from "./Date";
 import { ImportEmbed } from "./Embed";
+import { ImportGeoPoint } from "./GeoPoint";
 import { ImportImage } from "./Image";
+import { ImportRichText } from "./ImportRichText";
+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 | ImportImage;
+export declare type ImportNestable = ImportBoolean | ImportColor | ImportNumber | ImportSelect | ImportText | ImportDate | ImportTimestamp | ImportEmbed | ImportLink | ImportGeoPoint | ImportImage | ImportRichText;
 export declare const ImportNestable: {
     is(u: unknown): u is ImportNestable;
     decode: (field: NestableWidget) => (content: unknown) => {
@@ -23,49 +26,43 @@ 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;
+                longitude: number;
+            } | null;
+        }, {
+            latitude: number;
+            longitude: number;
+        } | undefined, unknown> | import("io-ts").Type<{
             type: "Image";
-            value: (import("./Image").ImageField & {
-                thumbnails: Record<string, import("./Image").ImageField>;
-            }) | null;
-        }, (import("./Image").ImageField & {
-            thumbnails: Record<string, import("./Image").ImageField>;
-        }) | undefined, unknown> | import("io-ts").Type<{
+            value: import("./Image").ImageFieldWithThumbnails | null;
+        }, import("./Image").ImageFieldWithThumbnails | 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: "StructuredText";
+            value: import("./ImportRichText").ImportBlock[] | null;
+        }, unknown[] | undefined, unknown> | import("io-ts").Type<{
             type: "Number";
             value: number | null;
         }, number | undefined, unknown> | import("io-ts").Type<{
@@ -90,31 +87,37 @@ export declare const ImportNestable: {
         }> | import("fp-ts/lib/Either").Right<{
             type: "Number";
             value: number | null;
+        }> | import("fp-ts/lib/Either").Right<{
+            type: "StructuredText";
+            value: import("./ImportRichText").ImportBlock[] | 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: (import("./Image").ImageField & {
-                thumbnails: Record<string, import("./Image").ImageField>;
-            }) | null;
+            value: import("./Image").ImageFieldWithThumbnails | null;
+        }> | import("fp-ts/lib/Either").Right<{
+            type: "GeoPoint";
+            value: {
+                latitude: number;
+                longitude: number;
+            } | 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/Nestable.js

@@ -1,18 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImportNestable = void 0;
-const _1 = require(".");
+const Boolean_1 = require("./Boolean");
 const Color_1 = require("./Color");
 const Date_1 = require("./Date");
 const Embed_1 = require("./Embed");
+const GeoPoint_1 = require("./GeoPoint");
 const Image_1 = require("./Image");
+const ImportRichText_1 = require("./ImportRichText");
+const Link_1 = require("./Link");
 const Number_1 = require("./Number");
 const Select_1 = require("./Select");
 const Text_1 = require("./Text");
 const Timestamp_1 = require("./Timestamp");
 exports.ImportNestable = {
     is(u) {
-        return (_1.ImportBoolean.is(u) ||
+        return (Boolean_1.ImportBoolean.is(u) ||
             Color_1.ImportColor.is(u) ||
             (0, Number_1.ImportNumber)().is(u) ||
             (0, Select_1.ImportSelect)().is(u) ||
@@ -20,14 +23,17 @@ exports.ImportNestable = {
             Date_1.ImportDate.is(u) ||
             Timestamp_1.ImportTimestamp.is(u) ||
             Embed_1.ImportEmbed.is(u) ||
-            Image_1.ImportImage.is(u));
+            Link_1.ImportLink.is(u) ||
+            GeoPoint_1.ImportGeoPoint.is(u) ||
+            (0, Image_1.ImportImage)().is(u) ||
+            (0, ImportRichText_1.ImportRichText)().is(u));
     },
     decode: (field) => {
         return (content) => {
             const codec = (() => {
                 switch (field.type) {
                     case "Boolean":
-                        return _1.ImportBoolean;
+                        return Boolean_1.ImportBoolean;
                     case "Color":
                         return Color_1.ImportColor;
                     case "Number":
@@ -40,10 +46,16 @@ 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 (0, Image_1.ImportImage)(field);
+                    case "GeoPoint":
+                        return GeoPoint_1.ImportGeoPoint;
+                    case "StructuredText":
+                        return (0, ImportRichText_1.ImportRichText)(field);
                     default:
                         throw new Error(`Unsupported type of nestable field ${field.type}`);
                 }

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

@@ -1,8 +1,12 @@
 export * from "./Boolean";
 export * from "./Color";
 export * from "./Date";
-export * from "./Embed";
+export { ImportEmbed } from "./Embed";
+export * from "./GeoPoint";
 export * from "./Image";
+export * from "./Image/index";
+export * from "./ImportRichText";
+export * from "./Link";
 export * from "./Nestable";
 export * from "./Number";
 export * from "./Select";

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

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImportEmbed = void 0;
 const tslib_1 = require("tslib");
 (0, tslib_1.__exportStar)(require("./Boolean"), exports);
 (0, tslib_1.__exportStar)(require("./Color"), exports);
 (0, tslib_1.__exportStar)(require("./Date"), exports);
-(0, tslib_1.__exportStar)(require("./Embed"), exports);
+var Embed_1 = require("./Embed");
+Object.defineProperty(exports, "ImportEmbed", { enumerable: true, get: function () { return Embed_1.ImportEmbed; } });
+(0, tslib_1.__exportStar)(require("./GeoPoint"), exports);
 (0, tslib_1.__exportStar)(require("./Image"), exports);
+(0, tslib_1.__exportStar)(require("./Image/index"), exports);
+(0, tslib_1.__exportStar)(require("./ImportRichText"), 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,2 @@
+import * as t from "io-ts";
+export declare const DocumentId: t.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 tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const function_1 = require("../validators/function");
+exports.DocumentId = (0, function_1.withCustomError)((0, function_1.refineType)(t.string, "DocumentId", (s) => s.length === 16), () => "DocumentId must be a 16 character string");

package/lib/utils/Objects.d.ts

@@ -5,4 +5,4 @@ export declare function zipObjects<A, B = A>(objLeft?: Partial<Record<string, A>
 export declare function isNotEmpty<A extends object>(obj: A): boolean;
 export declare function withOptionals<T extends object>(object: T, optionals: Array<[keyof T, T[keyof T] | null | undefined]>): T;
 export declare function isObject(value: unknown): value is Record<string, unknown>;
-export declare function mapValues<T, O>(record: Record<string, T>, fn: (value: T) => O): Record<string, O>;
+export declare function mapValues<T, O>(record: Record<string, T>, fn: (value: T, key: string) => O): Record<string, O>;

package/lib/utils/Objects.js

@@ -37,6 +37,6 @@ function isObject(value) {
 }
 exports.isObject = isObject;
 function mapValues(record, fn) {
-    return Object.entries(record).reduce((acc, [key, value]) => ({ ...acc, [key]: fn(value) }), {});
+    return Object.entries(record).reduce((acc, [key, value]) => ({ ...acc, [key]: fn(value, key) }), {});
 }
 exports.mapValues = mapValues;

package/lib/utils/io-ts.d.ts

@@ -0,0 +1,2 @@
+import type { Validation } from "io-ts";
+export declare const combineValidationResults: <T>(validationResults: readonly Validation<T>[]) => Validation<readonly T[]>;

package/lib/utils/io-ts.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.combineValidationResults = void 0;
+const tslib_1 = require("tslib");
+const E = (0, tslib_1.__importStar)(require("fp-ts/Either"));
+const function_1 = require("fp-ts/function");
+const RA = (0, tslib_1.__importStar)(require("fp-ts/ReadonlyArray"));
+/*
+ * 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 = {
+    concat: (a, b) => [...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.
+ */
+const combineValidationResults = (validationResults) => (0, function_1.pipe)(validationResults, RA.traverse(E.getApplicativeValidation(validationErrorsSemigroup))((validation) => validation));
+exports.combineValidationResults = combineValidationResults;

package/lib/validators/BasicTypes.d.ts

@@ -8,4 +8,3 @@ export declare const EmptyObject: t.Type<Record<never, never>, {
     [key: string]: unknown;
 }, unknown>;
 export declare const EmptyArray: t.Type<never[], never[], unknown>;
-export declare const AnyObject: t.RecordC<t.StringC, t.UnknownC>;

package/lib/validators/BasicTypes.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnyObject = exports.EmptyArray = exports.EmptyObject = exports.Boolean = exports.NumberOrNull = exports.Number = exports.StringOrNull = exports.String = void 0;
+exports.EmptyArray = exports.EmptyObject = exports.Boolean = exports.NumberOrNull = exports.Number = exports.StringOrNull = exports.String = void 0;
 const tslib_1 = require("tslib");
 const fp_ts_1 = require("fp-ts");
 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");
-exports.String = (0, io_ts_types_1.withMessage)(t.string, () => "The value must be a string");
-exports.StringOrNull = (0, io_ts_types_1.withMessage)(t.union([t.string, t.null]), () => "The value must be a string or null");
-exports.Number = (0, io_ts_types_1.withMessage)(t.number, () => "The value must be a number");
-exports.NumberOrNull = (0, io_ts_types_1.withMessage)(t.union([t.number, t.null]), () => "The value must be a number or null");
-exports.Boolean = (0, io_ts_types_1.withMessage)(t.boolean, () => "The value must be a boolean");
+const function_2 = require("./function");
+exports.String = (0, function_2.withCustomError)(t.string, () => "The value must be a string");
+exports.StringOrNull = (0, function_2.withCustomError)(t.union([t.string, t.null]), () => "The value must be a string or null");
+exports.Number = (0, function_2.withCustomError)(t.number, () => "The value must be a number");
+exports.NumberOrNull = (0, function_2.withCustomError)(t.union([t.number, t.null]), () => "The value must be a number or null");
+exports.Boolean = (0, function_2.withCustomError)(t.boolean, () => "The value must be a boolean");
 exports.EmptyObject = t.UnknownRecord.pipe(new t.Type("emptyObject", (u) => t.UnknownRecord.is(u), (u, c) => {
     if (Object.keys(u).length > 0)
         return t.failure(u, c, "The object is not empty.");
@@ -23,4 +23,3 @@ exports.EmptyArray = new t.Type("emptyArray", (u) => t.UnknownArray.is(u) && u.l
         return t.success(new Array());
     }));
 }, () => []);
-exports.AnyObject = (0, io_ts_types_1.withMessage)(t.record(t.string, t.unknown), () => "The value must be an object");

package/lib/validators/DefaultOrElse.js

@@ -6,7 +6,7 @@ const Either_1 = require("fp-ts/lib/Either");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const BasicTypes_1 = require("./BasicTypes");
 const DefaultOrElse = (inputValidator) => {
-    return (codec) => new t.Type("NullOrT", (u) => null === u || codec.is(u), (u) => {
+    return (codec) => new t.Type("DefaultOrElse", (u) => null === u || codec.is(u), (u) => {
         if ((0, Either_1.isRight)(inputValidator.decode(u)))
             return t.success(null);
         return codec.decode(u);

package/lib/validators/NonEmptyString.js

@@ -3,4 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const function_1 = require("./function");
-exports.default = (0, function_1.refineType)(t.string, "nonEmptyString", (s) => s.trim().length > 0);
+exports.default = (0, function_1.withCustomError)((0, function_1.refineType)(t.string, "nonEmptyString", (s) => s.trim().length > 0), () => "The value must be a non-empty string");

package/lib/validators/NumberRange.d.ts

@@ -0,0 +1,32 @@
+import * as t from "io-ts";
+declare const _default: (min: number, max: number, fieldName: string) => t.Type<number, number, unknown>;
+/**
+ * Creates a custom runtime type for validating that a number falls within a specified range.
+ *
+ * @param min - The minimum value of the range.
+ * @param max - The maximum value of the range.
+ * @param fieldName - The name of the field being validated (used in error messages).
+ * @returns A runtime type representing the number range validation.
+ *
+ *  * @example
+ * // Creating a custom runtime type for age validation
+ * const AgeType = numberInRange(18, 99, 'Age');
+ *
+ * // Valid age
+ * const validAgeResult = AgeType.decode(25);
+ * if (t.isRight(validAgeResult)) {
+ *   console.log('Valid age:', validAgeResult.right); // Output: Valid age: 25
+ * } else {
+ *   console.error('Invalid age:', t.left(validAgeResult).map(t.reporter.report));
+ * }
+ *
+ * @example
+ * // Invalid age
+ * const invalidAgeResult = AgeType.decode(15);
+ * if (t.isRight(invalidAgeResult)) {
+ *   console.log('Valid age:', invalidAgeResult.right);
+ * } else {
+ *   console.error('Invalid age:', t.left(invalidAgeResult).map(t.reporter.report));
+ * }
+ */
+export default _default;

package/lib/validators/NumberRange.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const BasicTypes_1 = require("./BasicTypes");
+/**
+ * Creates a custom runtime type for validating that a number falls within a specified range.
+ *
+ * @param min - The minimum value of the range.
+ * @param max - The maximum value of the range.
+ * @param fieldName - The name of the field being validated (used in error messages).
+ * @returns A runtime type representing the number range validation.
+ *
+ *  * @example
+ * // Creating a custom runtime type for age validation
+ * const AgeType = numberInRange(18, 99, 'Age');
+ *
+ * // Valid age
+ * const validAgeResult = AgeType.decode(25);
+ * if (t.isRight(validAgeResult)) {
+ *   console.log('Valid age:', validAgeResult.right); // Output: Valid age: 25
+ * } else {
+ *   console.error('Invalid age:', t.left(validAgeResult).map(t.reporter.report));
+ * }
+ *
+ * @example
+ * // Invalid age
+ * const invalidAgeResult = AgeType.decode(15);
+ * if (t.isRight(invalidAgeResult)) {
+ *   console.log('Valid age:', invalidAgeResult.right);
+ * } else {
+ *   console.error('Invalid age:', t.left(invalidAgeResult).map(t.reporter.report));
+ * }
+ */
+exports.default = (min, max, fieldName) => BasicTypes_1.Number.pipe(new t.Type("numberInRange", (u) => BasicTypes_1.Number.is(u), (u, context) => {
+    if (u > max || u < min) {
+        return t.failure(u, context, `${fieldName} must be a number between ${min} and ${max}`);
+    }
+    return t.success(u);
+}, t.identity));