@prismicio/types-internal 0.2.2 → 0.2.6

package/lib/validators/index.js

@@ -1,12 +1,27 @@
-export { default as DateFromString } from "./DateFromString";
-export { default as DateFromStringOrNumber } from "./DateFromStringOrNumber";
-export { default as DateFromTsMs } from "./DateFromTsMs";
-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 StringFromBoolean } from "./StringFromBoolean";
-export { default as StringFromNumber } from "./StringFromNumber";
-export { default as StringOrNull } from "./StringOrNull";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringOrNull = exports.StringFromNumber = exports.StringFromBoolean = 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");
+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; } });
+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 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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/types-internal",
-	"version": "0.2.2",
+	"version": "0.2.6",
 	"description": "Prismic types for Custom Types and Prismic Data",
 	"keywords": [
 		"typescript",

package/src/customtypes/CustomType.ts

@@ -10,7 +10,7 @@ import {
 	Sections,
 	StaticSection,
 } from "./Section"
-import type SharedSlice from "./widgets/slices/SharedSlice"
+import type { SharedSlice } from "./widgets/slices/SharedSlice"
 import type { DynamicSlice } from "./widgets/slices/Slice"
 import type { DynamicSlices } from "./widgets/slices/Slices"
 import SlicesTypes from "./widgets/slices/SlicesTypes"
@@ -58,10 +58,10 @@ export type StaticCustomType = t.TypeOf<typeof StaticCustomType>
 export const CustomType = customTypeReader(Format.Dynamic)
 export type CustomType = t.TypeOf<typeof CustomType>
 
-function _retrieveSharedSlicesRef(customType: CustomType): Array<string> {
-	const flattenWidgets: Array<[string, DynamicWidget]> = Object.entries(
-		customType.json,
-	).reduce(
+export function flattenWidgets(
+	customType: CustomType,
+): Array<[string, DynamicWidget]> {
+	return Object.entries(customType.json).reduce(
 		(
 			acc: Array<[string, DynamicWidget]>,
 			[, section]: [string, DynamicSection],
@@ -72,8 +72,9 @@ function _retrieveSharedSlicesRef(customType: CustomType): Array<string> {
 		},
 		[],
 	)
-
-	const slicezones = flattenWidgets.filter(
+}
+function _retrieveSharedSlicesRef(customType: CustomType): Array<string> {
+	const slicezones = flattenWidgets(customType).filter(
 		([, widget]: [string, DynamicWidget]) => widget.type === WidgetTypes.Slices,
 	) as Array<[string, DynamicSlices]>
 

package/src/customtypes/Section.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { Format } from "./Format"
-import type SharedSlice from "./widgets/slices/SharedSlice"
+import type { SharedSlice } from "./widgets/slices/SharedSlice"
 import {
 	DynamicWidget,
 	StaticWidget,

package/src/customtypes/widgets/Widget.ts

@@ -3,7 +3,7 @@ import * as t from "io-ts"
 import { Format } from "../Format"
 import Group from "./Group"
 import NestableWidget from "./nestable/NestableWidget"
-import type SharedSlice from "./slices/SharedSlice"
+import type { SharedSlice } from "./slices/SharedSlice"
 import { Slices, slicesReader } from "./slices/Slices"
 import UID from "./UID"
 import WidgetTypes from "./WidgetTypes"

package/src/customtypes/widgets/nestable/NestableWidget.ts

@@ -10,7 +10,7 @@ import IntegrationField from "./IntegrationField"
 import Link from "./Link"
 import Number from "./Number"
 import Range from "./Range"
-import RichText from "./RichText"
+import { RichText } from "./RichText"
 import Select from "./Select"
 import Separator from "./Separator"
 import Text from "./Text"

package/src/customtypes/widgets/nestable/RichText.ts

@@ -5,25 +5,67 @@ import { StringOrNull } from "../../../validators"
 import ImageConstraint from "../shared/ImageConstraint"
 import WidgetTypes from "../WidgetTypes"
 
-const DEFAULT_OPTION = "paragraph"
-const options = [
-	"heading1",
-	"heading2",
-	"heading3",
-	"heading4",
-	"heading5",
-	"heading6",
-	"paragraph",
-	"strong",
-	"em",
-	"preformatted",
-	"hyperlink",
-	"image",
-	"embed",
-	"list-item",
-	"o-list-item",
-	"rtl",
-]
+export const DEFAULT_OPTION = "paragraph"
+
+export enum RichTextNodeType {
+	heading1 = "heading1",
+	heading2 = "heading2",
+	heading3 = "heading3",
+	heading4 = "heading4",
+	heading5 = "heading5",
+	heading6 = "heading6",
+	paragraph = "paragraph",
+	strong = "strong",
+	em = "em",
+	preformatted = "preformatted",
+	hyperlink = "hyperlink",
+	image = "image",
+	embed = "embed",
+	list = "list-item",
+	orderedList = "o-list-item",
+	rtl = "rtl",
+}
+
+export function parseRichTextNodeType(
+	str: string,
+): RichTextNodeType | undefined {
+	switch (str) {
+		case RichTextNodeType.heading1:
+			return RichTextNodeType.heading1
+		case RichTextNodeType.heading2:
+			return RichTextNodeType.heading2
+		case RichTextNodeType.heading3:
+			return RichTextNodeType.heading3
+		case RichTextNodeType.heading4:
+			return RichTextNodeType.heading4
+		case RichTextNodeType.heading5:
+			return RichTextNodeType.heading5
+		case RichTextNodeType.heading6:
+			return RichTextNodeType.heading6
+		case RichTextNodeType.paragraph:
+			return RichTextNodeType.paragraph
+		case RichTextNodeType.strong:
+			return RichTextNodeType.strong
+		case RichTextNodeType.em:
+			return RichTextNodeType.em
+		case RichTextNodeType.preformatted:
+			return RichTextNodeType.preformatted
+		case RichTextNodeType.hyperlink:
+			return RichTextNodeType.hyperlink
+		case RichTextNodeType.image:
+			return RichTextNodeType.image
+		case RichTextNodeType.embed:
+			return RichTextNodeType.embed
+		case RichTextNodeType.list:
+			return RichTextNodeType.list
+		case RichTextNodeType.orderedList:
+			return RichTextNodeType.orderedList
+		case RichTextNodeType.rtl:
+			return RichTextNodeType.rtl
+		default:
+			return
+	}
+}
 
 const RichTextOptions = new t.Type<string, string, unknown>(
 	"RichTextOptions",
@@ -34,7 +76,7 @@ const RichTextOptions = new t.Type<string, string, unknown>(
 			(s: string | null) => {
 				if (!s) return t.success(DEFAULT_OPTION)
 				const entries = s.split(",").map((e: string) => e.trim())
-				const filtered = entries.filter((entry) => options.includes(entry))
+				const filtered = entries.filter((entry) => parseRichTextNodeType(entry))
 				if (!filtered.length) return t.success(DEFAULT_OPTION)
 
 				return t.success(filtered.join(","))
@@ -174,7 +216,7 @@ const RichTextConfig = t.exact(
 )
 type RichTextConfig = t.TypeOf<typeof RichTextConfig>
 
-const RichText = t.exact(
+export const RichText = t.exact(
 	t.intersection([
 		t.type({
 			type: t.literal(WidgetTypes.RichText),
@@ -185,6 +227,4 @@ const RichText = t.exact(
 		}),
 	]),
 )
-type RichText = t.TypeOf<typeof RichText>
-
-export default RichText
+export type RichText = t.TypeOf<typeof RichText>

package/src/customtypes/widgets/nestable/index.ts

@@ -1,6 +1,7 @@
 export { default as BooleanField } from "./BooleanField"
 export { default as Color } from "./Color"
 export { default as Date } from "./Date"
+export { default as Embed } from "./Embed"
 export { default as GeoPoint } from "./GeoPoint"
 export { default as Image } from "./Image"
 export { default as IntegrationField } from "./IntegrationField"
@@ -8,7 +9,7 @@ export { default as Link } from "./Link"
 export { default as NestableWidget } from "./NestableWidget"
 export { default as Number } from "./Number"
 export { default as Range } from "./Range"
-export { default as RichText } from "./RichText"
+export * from "./RichText"
 export { default as Select } from "./Select"
 export { default as Separator } from "./Separator"
 export { default as Text } from "./Text"

package/src/customtypes/widgets/slices/LegacySlice.ts

@@ -2,9 +2,8 @@ import * as t from "io-ts"
 
 import Group from "../Group"
 import NestableWidget from "../nestable/NestableWidget"
-import UID from "../UID"
 
-const LegacySlice = t.union([UID, NestableWidget, Group])
+const LegacySlice = t.union([NestableWidget, Group])
 
 type LegacySlice = t.TypeOf<typeof LegacySlice>
 

package/src/customtypes/widgets/slices/SharedSlice.ts

@@ -7,7 +7,7 @@ import SlicesTypes from "./SlicesTypes"
 const IMAGE_PLACEHOLDER_URL =
 	"https://images.prismic.io/slice-machine/621a5ec4-0387-4bc5-9860-2dd46cbc07cd_default_ss.png?auto=compress,format"
 
-const Variation = t.exact(
+export const Variation = t.exact(
 	t.intersection([
 		t.type({
 			id: t.string,
@@ -25,9 +25,9 @@ const Variation = t.exact(
 	]),
 )
 
-type Variation = t.TypeOf<typeof Variation>
+export type Variation = t.TypeOf<typeof Variation>
 
-const SharedSlice = t.exact(
+export const SharedSlice = t.exact(
 	t.intersection([
 		t.type({
 			id: t.string,
@@ -41,6 +41,4 @@ const SharedSlice = t.exact(
 	]),
 )
 
-type SharedSlice = t.TypeOf<typeof SharedSlice>
-
-export default SharedSlice
+export type SharedSlice = t.TypeOf<typeof SharedSlice>

package/src/customtypes/widgets/slices/Slice.ts

@@ -1,6 +1,6 @@
 import type CompositeSlice from "./CompositeSlice"
 import type LegacySlice from "./LegacySlice"
-import type SharedSlice from "./SharedSlice"
+import type { SharedSlice } from "./SharedSlice"
 import type SharedSliceRef from "./SharedSliceRef"
 
 export type DynamicSlice = CompositeSlice | LegacySlice | SharedSliceRef

package/src/customtypes/widgets/slices/Slices.ts

@@ -5,7 +5,7 @@ import { Format } from "../../Format"
 import WidgetTypes from "../WidgetTypes"
 import CompositeSlice from "./CompositeSlice"
 import LegacySlice from "./LegacySlice"
-import SharedSlice from "./SharedSlice"
+import { SharedSlice } from "./SharedSlice"
 import SharedSliceRef from "./SharedSliceRef"
 import SlicesTypes from "./SlicesTypes"
 

package/src/customtypes/widgets/slices/index.ts

@@ -1,6 +1,6 @@
 export { default as CompositeSlice } from "./CompositeSlice"
 export { default as LegacySlice } from "./LegacySlice"
-export { default as SharedSlice } from "./SharedSlice"
+export * from "./SharedSlice"
 export { default as SharedSliceRef } from "./SharedSliceRef"
 export * as Slice from "./Slice"
 export * as SliceZone from "./Slices"

package/src/documents/widgets/SimpleWidgetContent.ts

@@ -4,8 +4,8 @@ import * as t from "io-ts"
 
 import type { EmptyContent } from "./EmptyContent"
 import BooleanContent from "./nestable/BooleanContent"
-import EmbedContent from "./nestable/EmbedContent"
-import FieldContent from "./nestable/FieldContent"
+import { EmbedContent, EmbedContentO } from "./nestable/EmbedContent"
+import FieldContent, { FieldType } from "./nestable/FieldContent"
 import { GeoPointContent, GeoPointContentO } from "./nestable/GeoPointContent"
 import { ImageContent, ImageContentO } from "./nestable/ImageContent"
 import IntegrationFieldsContent from "./nestable/IntegrationFieldsContent"
@@ -34,7 +34,7 @@ export type NonEmptySimpleWidgetContent =
 	| StructuredTextContent
 	| ImageContentO
 	| GeoPointContentO
-	| EmbedContent
+	| EmbedContentO
 	| LinkContent
 	| UIDContent
 	| SeparatorContent
@@ -84,7 +84,7 @@ export const SimpleWidgetContent = {
 				return O.fromEither(BooleanContent.decode(content))
 			default:
 				if (FieldContent.types.includes(type)) {
-					return FieldContent.forType(type, content)
+					return FieldContent.forType(type as FieldType, content)
 				} else {
 					return O.none
 				}

package/src/documents/widgets/index.ts

@@ -22,7 +22,7 @@ export const WidgetTypes = {
 	UID: UIDContentType,
 	Group: GroupContentType,
 	slices: SlicesContentType,
-}
+} as const
 
 export type WidgetKey = string
 export type WidgetContent = SlicesContent | StaticWidgetContent

package/src/documents/widgets/nestable/EmbedContent.ts

@@ -7,13 +7,17 @@ import { addType } from "../../../validators/function"
 
 export const EmbedContentType = "EmbedContent"
 
-type EmbedContent = t.OutputOf<typeof EmbedContentC> & {
+export type EmbedContent = t.TypeOf<typeof EmbedContentC> & {
 	all: unknown
 }
 
-const EmbedContent = new t.Type<EmbedContent, unknown, unknown>(
+export type EmbedContentO = t.OutputOf<typeof EmbedContentC> & {
+	all: unknown
+}
+
+export const EmbedContent = new t.Type<EmbedContentO, unknown, unknown>(
 	"EmbedContent",
-	(u): u is EmbedContent => (u as EmbedContent).__TYPE__ === EmbedContentType,
+	(u): u is EmbedContentO => (u as EmbedContentO).__TYPE__ === EmbedContentType,
 	(u) => {
 		return pipe(
 			EmbedContentC.decode(u),
@@ -23,7 +27,7 @@ const EmbedContent = new t.Type<EmbedContent, unknown, unknown>(
 			})),
 		)
 	},
-	(ec: EmbedContent) => EmbedContentC.encode(ec),
+	(ec: EmbedContentO) => EmbedContentC.encode(ec),
 )
 
 const EmbedContentC = addType(
@@ -50,5 +54,3 @@ const EmbedContentC = addType(
 	),
 	EmbedContentType,
 )
-
-export default EmbedContent

package/src/documents/widgets/nestable/FieldContent.ts

@@ -2,10 +2,18 @@ import { pipe } from "fp-ts/function"
 import * as O from "fp-ts/Option"
 import * as t from "io-ts"
 
+export type FieldType =
+	| "Text"
+	| "Date"
+	| "Timestamp"
+	| "Color"
+	| "Number"
+	| "Range"
+	| "Select"
 export const FieldContentType = "FieldContent"
 type FieldContent = {
 	value: string
-	type: string
+	type: FieldType
 	__TYPE__: typeof FieldContentType
 }
 
@@ -28,7 +36,7 @@ function trimScalaStyle(s: string): string {
 
 const FieldContent = {
 	types: ["Text", "Date", "Timestamp", "Color", "Number", "Range", "Select"],
-	forType: (type: string, value: unknown): O.Option<FieldContent> => {
+	forType: (type: FieldType, value: unknown): O.Option<FieldContent> => {
 		return pipe(
 			O.fromEither(t.string.decode(value)),
 			O.map((r) => {

package/src/documents/widgets/nestable/Link/index.ts

@@ -30,4 +30,4 @@ export const LinksTypes = {
 	ExternalLink: ExternalLinkType,
 	ImageLink: ImageLinkType,
 	LinkContent: LinkContentType,
-}
+} as const

package/src/documents/widgets/nestable/StructuredTextContent/Block.ts

@@ -3,7 +3,7 @@ import * as t from "io-ts"
 
 import { StringOrNull } from "../../../../validators"
 import { nullable, refineType } from "../../../../validators/function"
-import EmbedContent from "../EmbedContent"
+import { EmbedContent } from "../EmbedContent"
 import { ImageContentView } from "../ImageContent"
 import { Link } from "../Link"
 

package/src/documents/widgets/nestable/index.ts

@@ -9,7 +9,7 @@ import { SeparatorContentType } from "./SeparatorContent"
 import { StructuredTextContentType } from "./StructuredTextContent"
 
 export { default as BooleanContent } from "./BooleanContent"
-export { default as EmbedContent } from "./EmbedContent"
+export * from "./EmbedContent"
 export { default as FieldContent } from "./FieldContent"
 export { type GeoPointContentO, GeoPointContent } from "./GeoPointContent"
 export {
@@ -32,4 +32,4 @@ export const NestableTypes = {
 	Image: ImageContentType,
 	IntegrationFields: IntegrationFieldsContentType,
 	Separator: SeparatorContentType,
-}
+} as const