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

package/lib/validators/StringOrNull.js

@@ -1,6 +0,0 @@
-"use strict";
-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.nullable)(t.string);

package/lib/validators/TrimmedString.d.ts

@@ -1,5 +0,0 @@
-import * as t from "io-ts";
-export declare type TrimmedStringC = t.Type<string, string, unknown>;
-declare const _default: t.Type<string, string, unknown>;
-/** A codec that validates a Boolean and convert it as a string */
-export default _default;

package/lib/validators/TrimmedString.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const Either_1 = require("fp-ts/Either");
-const function_1 = require("fp-ts/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-function trimScalaStyle(s) {
-    let startAt = 0;
-    /* eslint-disable  @typescript-eslint/no-non-null-assertion */
-    while (startAt < s.length && s[startAt] <= " ") {
-        startAt++;
-    }
-    let endAt = s.length;
-    /* eslint-disable  @typescript-eslint/no-non-null-assertion */
-    while (startAt < endAt && s[endAt - 1] <= " ") {
-        endAt--;
-    }
-    return s.substring(startAt, endAt);
-}
-/** A codec that validates a Boolean and convert it as a string */
-exports.default = new t.Type("TrimmedString", t.string.is, (u, c) => (0, function_1.pipe)(t.string.validate(u, c), (0, Either_1.chain)((s) => {
-    return t.success(trimScalaStyle(s));
-})), (i) => i);

package/lib/validators/function.d.ts

@@ -1,34 +0,0 @@
-import * as t from "io-ts";
-export declare function nullable<A, O>(c: t.Type<A, O>): t.UnionC<[t.Type<A, O, unknown>, t.NullC, t.UndefinedC]>;
-export declare function refineType<A, O, I>(type: t.Type<A, O, I>, newName: string, pred: (a: A) => boolean): t.Type<A, O, I>;
-export declare function filterDouble(value: string): number | null;
-export declare function formatDateTime(date: Date): string;
-export declare function formatDate(date: Date): string;
-export declare function grouped<A>(array: A[], n: number): A[][];
-export declare function objectToMap<T>(object: {
-    [key: string]: T;
-}): Map<string, T>;
-export declare function isEmpty(obj: object): boolean;
-export declare function addType<A, O extends object, I, T extends string>(codec: t.Type<A, O, I>, t: T): t.Type<A, O & {
-    __TYPE__: T;
-}, I>;
-/**
- * Returns a clone of the given codec that tries to find sub-error with message already set.
- * If there is such error it just returns sub-errors array.
- * If there is no such error it generates new error with given message.
- *
- * @example
- * expect(
- * 		withCustomError(
- * 			t.type({age: withCustomError(t.number, () => 'Invalid child')}),
- * 			() => "Invalid parent"
- * 		)
- * ).toSubsetEqualLeft([{message: "Invalid child"}])
- * expect(
- * 		withCustomError(
- * 			t.type({age: t.number}),
- * 			() => "Invalid parent"
- * 		)
- * ).toSubsetEqualLeft([{message: "Invalid parent"}])
- */
-export declare function withCustomError<C extends t.Any>(codec: C, message: (i: t.InputOf<C>, c: t.Context) => string): C;

package/lib/validators/function.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withCustomError = exports.addType = exports.isEmpty = exports.objectToMap = exports.grouped = exports.formatDate = exports.formatDateTime = exports.filterDouble = exports.refineType = exports.nullable = void 0;
-const tslib_1 = require("tslib");
-const fp_ts_1 = require("fp-ts");
-const function_1 = require("fp-ts/function");
-const t = (0, tslib_1.__importStar)(require("io-ts"));
-const io_ts_types_1 = require("io-ts-types");
-const mapOutput_1 = require("io-ts-types/mapOutput");
-function nullable(c) {
-    return t.union([c, t.null, t.undefined]);
-}
-exports.nullable = nullable;
-function refineType(type, newName, pred) {
-    return new t.Type(newName, type.is, (u, c) => (0, function_1.pipe)(type.validate(u, c), fp_ts_1.either.chain((v) => (pred(v) ? t.success(v) : t.failure(u, c)))), type.encode);
-}
-exports.refineType = refineType;
-function filterDouble(value) {
-    if (value === "") {
-        return null;
-    }
-    const result = Number(value);
-    return Number.isNaN(result) ? null : result;
-}
-exports.filterDouble = filterDouble;
-function formatDateTime(date) {
-    return date.toISOString().replace(/\.\d{3}Z$/, "+0000");
-}
-exports.formatDateTime = formatDateTime;
-function formatDate(date) {
-    return date.toISOString().replace(/T.*/, "");
-}
-exports.formatDate = formatDate;
-function grouped(array, n) {
-    return array.reduce((acc, curr, idx) => {
-        if (idx % n === 0) {
-            acc.push([curr]);
-        }
-        else {
-            /* eslint-disable  @typescript-eslint/no-non-null-assertion */
-            acc[Math.floor(idx / n)].push(curr);
-        }
-        return acc;
-    }, new Array());
-}
-exports.grouped = grouped;
-function objectToMap(object) {
-    return new Map(Object.entries(object));
-}
-exports.objectToMap = objectToMap;
-function isEmpty(obj) {
-    for (const _x in obj) {
-        return false;
-    }
-    return true;
-}
-exports.isEmpty = isEmpty;
-function addType(codec, t) {
-    return (0, mapOutput_1.mapOutput)(codec, (o) => ({ ...o, __TYPE__: t }));
-}
-exports.addType = addType;
-/**
- * Returns a clone of the given codec that tries to find sub-error with message already set.
- * If there is such error it just returns sub-errors array.
- * If there is no such error it generates new error with given message.
- *
- * @example
- * expect(
- * 		withCustomError(
- * 			t.type({age: withCustomError(t.number, () => 'Invalid child')}),
- * 			() => "Invalid parent"
- * 		)
- * ).toSubsetEqualLeft([{message: "Invalid child"}])
- * expect(
- * 		withCustomError(
- * 			t.type({age: t.number}),
- * 			() => "Invalid parent"
- * 		)
- * ).toSubsetEqualLeft([{message: "Invalid parent"}])
- */
-function withCustomError(codec, message) {
-    return (0, io_ts_types_1.withValidate)(codec, (i, c) => {
-        return fp_ts_1.either.mapLeft((errors) => {
-            if (errors.find((error) => error.message)) {
-                return errors;
-            }
-            return [
-                {
-                    value: i,
-                    context: c,
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-                    message: message(i, c),
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                    actual: i,
-                },
-            ];
-        })(codec.validate(i, c));
-    });
-}
-exports.withCustomError = withCustomError;

package/lib/validators/index.d.ts

@@ -1,15 +0,0 @@
-export * from "./BasicTypes";
-export { default as DateFromString } from "./DateFromString";
-export { default as DateFromStringOrNumber } from "./DateFromStringOrNumber";
-export { default as DateFromTsMs } from "./DateFromTsMs";
-export * from "./DefaultOrElse";
-export * as Function from "./function";
-export { default as IntFromNumber } from "./IntFromNumber";
-export { default as IntFromPixels } from "./IntFromPixels";
-export { default as NonEmptyString } from "./NonEmptyString";
-export { default as NonEmptyStringOrNull } from "./NonEmptyStringOrNull";
-export { default as NumberOrNull } from "./NumberOrNull";
-export { default as NumberRange } from "./NumberRange";
-export { default as StringFromBoolean } from "./StringFromBoolean";
-export { default as StringFromNumber } from "./StringFromNumber";
-export { default as StringOrNull } from "./StringOrNull";

package/lib/validators/index.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringOrNull = exports.StringFromNumber = exports.StringFromBoolean = exports.NumberRange = exports.NumberOrNull = exports.NonEmptyStringOrNull = exports.NonEmptyString = exports.IntFromPixels = exports.IntFromNumber = exports.Function = exports.DateFromTsMs = exports.DateFromStringOrNumber = exports.DateFromString = void 0;
-const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./BasicTypes"), exports);
-var DateFromString_1 = require("./DateFromString");
-Object.defineProperty(exports, "DateFromString", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(DateFromString_1).default; } });
-var DateFromStringOrNumber_1 = require("./DateFromStringOrNumber");
-Object.defineProperty(exports, "DateFromStringOrNumber", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(DateFromStringOrNumber_1).default; } });
-var DateFromTsMs_1 = require("./DateFromTsMs");
-Object.defineProperty(exports, "DateFromTsMs", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(DateFromTsMs_1).default; } });
-(0, tslib_1.__exportStar)(require("./DefaultOrElse"), exports);
-exports.Function = (0, tslib_1.__importStar)(require("./function"));
-var IntFromNumber_1 = require("./IntFromNumber");
-Object.defineProperty(exports, "IntFromNumber", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(IntFromNumber_1).default; } });
-var IntFromPixels_1 = require("./IntFromPixels");
-Object.defineProperty(exports, "IntFromPixels", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(IntFromPixels_1).default; } });
-var NonEmptyString_1 = require("./NonEmptyString");
-Object.defineProperty(exports, "NonEmptyString", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(NonEmptyString_1).default; } });
-var NonEmptyStringOrNull_1 = require("./NonEmptyStringOrNull");
-Object.defineProperty(exports, "NonEmptyStringOrNull", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(NonEmptyStringOrNull_1).default; } });
-var NumberOrNull_1 = require("./NumberOrNull");
-Object.defineProperty(exports, "NumberOrNull", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(NumberOrNull_1).default; } });
-var NumberRange_1 = require("./NumberRange");
-Object.defineProperty(exports, "NumberRange", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(NumberRange_1).default; } });
-var StringFromBoolean_1 = require("./StringFromBoolean");
-Object.defineProperty(exports, "StringFromBoolean", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(StringFromBoolean_1).default; } });
-var StringFromNumber_1 = require("./StringFromNumber");
-Object.defineProperty(exports, "StringFromNumber", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(StringFromNumber_1).default; } });
-var StringOrNull_1 = require("./StringOrNull");
-Object.defineProperty(exports, "StringOrNull", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(StringOrNull_1).default; } });

package/src/common/Asset.ts

@@ -1,25 +0,0 @@
-export type Asset = {
-	id: string
-	last_modified: string
-	kind: "image" | "all"
-	filename?: string
-	extension?: string
-	size?: number
-	origin_url: string
-	url: string
-	width?: number
-	height?: number
-	notes?: string
-	credits?: string
-	alt?: string
-}
-
-export const getAssetOrThrow =
-	(assets: Record<Asset["id"], Asset | undefined>) =>
-	(assetId: Asset["id"]) => {
-		const asset = assets[assetId]
-		if (!asset) {
-			throw new Error(`Missing asset with id '${assetId}'!`)
-		}
-		return asset
-	}

package/src/common/Embed.ts

@@ -1,22 +0,0 @@
-// This type represents response format from oEmbed API
-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 const getEmbedOrThrow =
-	(embeds: Record<string, Embed | undefined>) => (embedUrl: string) => {
-		const embed = embeds[embedUrl]
-		if (!embed) throw new Error(`Missing embed with url '${embedUrl}'`)
-		return embed
-	}

package/src/common/HexaColorCode.ts

@@ -1,11 +0,0 @@
-/*
- ** This type is not exhaustif because typescript can't compute all the possible solutions if we try to be explicit
- ** more information: https://medium.com/@steve.alves2/how-to-type-hex-colors-in-typescript-3c3b9a32baa7
- */
-export type HexaColorCode = `#${string}`
-
-const hexaColorCodeRegex = /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/
-export const HexaColor = {
-	is: (strColor: string): strColor is HexaColorCode =>
-		hexaColorCodeRegex.test(strColor),
-}

package/src/common/UUID.ts

@@ -1,19 +0,0 @@
-import * as t from "io-ts"
-import { validate as validateUUID } from "uuid"
-
-import { withCustomError } from "../validators/function"
-
-export interface UUIDBrand {
-	readonly UUID: unique symbol
-}
-
-export const UUID = withCustomError(
-	t.brand(
-		t.string,
-		(s): s is t.Branded<string, UUIDBrand> => validateUUID(s),
-		"UUID",
-	),
-	() => "The value must be a valid UUID",
-)
-
-export type UUID = t.TypeOf<typeof UUID>

package/src/common/WidgetKey.ts

@@ -1,13 +0,0 @@
-import * as t from "io-ts"
-
-import { refineType } from "../validators/function"
-
-const widgetKeyRegex = new RegExp("^[^<>]+$")
-
-export const WidgetKey = refineType(
-	t.string,
-	"WidgetKey",
-	(s: string) => s.length === 0 || widgetKeyRegex.test(s),
-)
-
-export type WidgetKey = t.TypeOf<typeof WidgetKey>

package/src/common/index.ts

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