@prismicio/types-internal 1.0.0-alpha.0 → 1.0.1

package/lib/customtypes/widgets/slices/Slices.js

@@ -4,12 +4,12 @@ exports.Slices = exports.DynamicSlices = exports.StaticSlices = exports.slicesRe
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
 const validators_1 = require("../../../validators");
-const WidgetTypes_1 = (0, tslib_1.__importDefault)(require("../WidgetTypes"));
+const WidgetTypes_1 = require("../WidgetTypes");
 const CompositeSlice_1 = (0, tslib_1.__importDefault)(require("./CompositeSlice"));
 const LegacySlice_1 = (0, tslib_1.__importDefault)(require("./LegacySlice"));
 const SharedSlice_1 = require("./SharedSlice");
 const SharedSliceRef_1 = (0, tslib_1.__importDefault)(require("./SharedSliceRef"));
-const SlicesTypes_1 = (0, tslib_1.__importDefault)(require("./SlicesTypes"));
+const SlicesTypes_1 = require("./SlicesTypes");
 exports.SlicesLabels = t.union([
     t.record(t.string, t.readonlyArray(t.exact(t.intersection([
         t.type({
@@ -34,7 +34,7 @@ exports.DynamicSlicesConfig = slicesConfigReader(SharedSliceRef_1.default);
 const SlicesConfig = {
     toStatic(config, sharedSlices) {
         const choices = Object.entries(config.choices || {}).reduce((acc, [ref, slice]) => {
-            if (slice.type === SlicesTypes_1.default.SharedSlice) {
+            if (slice.type === SlicesTypes_1.SlicesTypes.SharedSlice) {
                 const sharedSlice = sharedSlices.get(ref);
                 if (sharedSlice)
                     return { ...acc, [ref]: sharedSlice };
@@ -52,8 +52,8 @@ function slicesReader(codec) {
     return t.exact(t.intersection([
         t.type({
             type: t.union([
-                t.literal(WidgetTypes_1.default.Slices),
-                t.literal(WidgetTypes_1.default.LegacySlices),
+                t.literal(WidgetTypes_1.WidgetTypes.Slices),
+                t.literal(WidgetTypes_1.WidgetTypes.LegacySlices),
             ]),
         }),
         t.partial({

package/lib/customtypes/widgets/slices/SlicesTypes.d.ts

@@ -1,5 +1,5 @@
-declare const SlicesTypes: {
+export declare const SlicesTypes: {
     readonly Slice: "Slice";
     readonly SharedSlice: "SharedSlice";
 };
-export default SlicesTypes;
+export declare type SlicesTypes = typeof SlicesTypes[keyof typeof SlicesTypes];

package/lib/customtypes/widgets/slices/SlicesTypes.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const SlicesTypes = {
+exports.SlicesTypes = void 0;
+exports.SlicesTypes = {
     Slice: "Slice",
     SharedSlice: "SharedSlice",
 };
-exports.default = SlicesTypes;

package/lib/customtypes/widgets/slices/index.d.ts

@@ -4,4 +4,4 @@ export * from "./SharedSlice";
 export { default as SharedSliceRef } from "./SharedSliceRef";
 export * as Slice from "./Slice";
 export * as SliceZone from "./Slices";
-export { default as SlicesTypes } from "./SlicesTypes";
+export { SlicesTypes } from "./SlicesTypes";

package/lib/customtypes/widgets/slices/index.js

@@ -12,4 +12,4 @@ Object.defineProperty(exports, "SharedSliceRef", { enumerable: true, get: functi
 exports.Slice = (0, tslib_1.__importStar)(require("./Slice"));
 exports.SliceZone = (0, tslib_1.__importStar)(require("./Slices"));
 var SlicesTypes_1 = require("./SlicesTypes");
-Object.defineProperty(exports, "SlicesTypes", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(SlicesTypes_1).default; } });
+Object.defineProperty(exports, "SlicesTypes", { enumerable: true, get: function () { return SlicesTypes_1.SlicesTypes; } });

package/lib/documents/widgets/index.d.ts

@@ -1,4 +1,4 @@
-import { SlicesContent } from "./slices/SlicesContent";
+import { SlicesContent } from "./slices";
 import StaticWidgetContent from "./StaticWidgetContent";
 export * from "./EmptyContent";
 export * from "./GroupContent";
@@ -28,6 +28,7 @@ export declare const WidgetTypes: {
     readonly IntegrationFields: "IntegrationFieldsContent";
     readonly Separator: "SeparatorContent";
 };
+export declare type WidgetTypes = typeof WidgetTypes[keyof typeof WidgetTypes];
 export declare type WidgetKey = string;
 export declare type WidgetContent = SlicesContent | StaticWidgetContent;
 export declare const Widget: {

package/lib/documents/widgets/index.js

@@ -5,7 +5,7 @@ const tslib_1 = require("tslib");
 const EmptyContent_1 = require("./EmptyContent");
 const GroupContent_1 = require("./GroupContent");
 const nestable_1 = require("./nestable");
-const SlicesContent_1 = require("./slices/SlicesContent");
+const slices_1 = require("./slices");
 const StaticWidgetContent_1 = (0, tslib_1.__importDefault)(require("./StaticWidgetContent"));
 const UIDContent_1 = require("./UIDContent");
 (0, tslib_1.__exportStar)(require("./EmptyContent"), exports);
@@ -21,13 +21,13 @@ exports.WidgetTypes = {
     Empty: EmptyContent_1.EmptyContentType,
     UID: UIDContent_1.UIDContentType,
     Group: GroupContent_1.GroupContentType,
-    slices: SlicesContent_1.SlicesContentType,
+    slices: slices_1.SlicesContentType,
 };
 exports.Widget = {
     fromJson(widgetKey, widgetValue, widgetTypes, widgetPositions) {
         const fieldType = widgetTypes.get(widgetKey);
         if (fieldType === "Slices") {
-            return SlicesContent_1.SlicesContent.fromJson(widgetKey, widgetValue, widgetTypes, widgetPositions);
+            return slices_1.SlicesContent.fromJson(widgetKey, widgetValue, widgetTypes, widgetPositions);
         }
         else {
             return StaticWidgetContent_1.default.fromJson([], widgetKey, widgetValue, widgetTypes, widgetPositions);

package/lib/documents/widgets/nestable/Link/index.d.ts

@@ -87,3 +87,4 @@ export declare const LinksTypes: {
     readonly ImageLink: "ImageLink";
     readonly LinkContent: "LinkContent";
 };
+export declare type LinksTypes = typeof LinksTypes[keyof typeof LinksTypes];

package/lib/documents/widgets/nestable/StructuredTextContent/Block.js

@@ -17,7 +17,7 @@ exports.Meta = t.exact(t.intersection([
     t.type({
         start: t.number,
         end: t.number,
-        type: t.union([nestable_1.RichTextNodeTypeCodec, t.literal('label')]),
+        type: t.union([nestable_1.RichTextNodeTypeCodec, t.literal("label")]),
     }),
 ]));
 // export alias for code clarity

package/package.json

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

package/src/customtypes/CustomType.ts

@@ -7,9 +7,9 @@ import { DynamicSection, Sections, StaticSection } from "./Section"
 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"
+import { SlicesTypes } from "./widgets/slices/SlicesTypes"
 import type { DynamicWidget } from "./widgets/Widget"
-import WidgetTypes from "./widgets/WidgetTypes"
+import { WidgetTypes } from "./widgets/WidgetTypes"
 
 class CustomTypeSlicesError extends Error {
 	slices: Array<string>
@@ -38,7 +38,7 @@ function customTypeReader<T extends StaticSection | DynamicSection>(
 				id: t.string,
 				label: StringOrNull,
 				repeatable: withFallback(t.boolean, true),
-				json: t.record(t.string, codec),
+				json: t.record(t.string, codec), //tab name => tab data
 				status: withFallback(t.boolean, true),
 			}),
 			t.partial({

package/src/customtypes/Section.ts

@@ -1,12 +1,12 @@
 import * as t from "io-ts"
 
-import type { SharedSlice } from "./widgets/slices/SharedSlice"
+import type { SharedSlice } from "./widgets/slices"
 import { DynamicWidget, StaticWidget, Widgets } from "./widgets/Widget"
 
 export function sectionReader<T extends StaticWidget | DynamicWidget>(
 	codec: t.Type<T, unknown>,
 ) {
-	return t.record(t.string, codec)
+	return t.record(t.string, codec) // WidgetId -> Widget Data
 }
 
 export const StaticSection = sectionReader(StaticWidget)

package/src/customtypes/widgets/Group.ts

@@ -2,7 +2,7 @@ import * as t from "io-ts"
 
 import { StringOrNull } from "../../validators"
 import NestableWidget from "./nestable/NestableWidget"
-import WidgetTypes from "./WidgetTypes"
+import { WidgetTypes } from "./WidgetTypes"
 
 const GroupConfig = t.exact(
 	t.partial({

package/src/customtypes/widgets/UID.ts

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../validators"
-import WidgetTypes from "./WidgetTypes"
+import { WidgetTypes } from "./WidgetTypes"
 
 const UIDConfig = t.exact(
 	t.partial({

package/src/customtypes/widgets/Widget.ts

@@ -5,7 +5,7 @@ import NestableWidget from "./nestable/NestableWidget"
 import type { SharedSlice } from "./slices/SharedSlice"
 import { DynamicSlices, Slices, StaticSlices } from "./slices/Slices"
 import UID from "./UID"
-import WidgetTypes from "./WidgetTypes"
+import { WidgetTypes } from "./WidgetTypes"
 
 export function widgetReader<T extends StaticSlices | DynamicSlices>(
 	codec: t.Type<T, unknown>,

package/src/customtypes/widgets/WidgetTypes.ts

@@ -1,4 +1,4 @@
-const WidgetTypes = {
+export const WidgetTypes = {
 	Text: "Text",
 	RichText: "StructuredText",
 	Color: "Color",
@@ -21,4 +21,4 @@ const WidgetTypes = {
 	LegacySlices: "Choice",
 } as const
 
-export default WidgetTypes
+export type WidgetTypes = typeof WidgetTypes[keyof typeof WidgetTypes]

package/src/customtypes/widgets/index.ts

@@ -4,4 +4,4 @@ export * as Shared from "./shared"
 export * as Slices from "./slices"
 export { default as UID } from "./UID"
 export * as Widget from "./Widget"
-export { default as WidgetTypes } from "./WidgetTypes"
+export { WidgetTypes } from "./WidgetTypes"

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const BooleanConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const ColorConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const DateConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const EmbedConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const GeoPointConfig = t.exact(
 	t.partial({

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

@@ -2,7 +2,7 @@ import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
 import ImageConstraint from "../shared/ImageConstraint"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const Thumbnail = t.exact(
 	t.intersection([

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const IntegrationFieldConfig = t.exact(
 	t.partial({

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

@@ -3,7 +3,7 @@ import * as t from "io-ts"
 import { withFallback } from "io-ts-types/lib/withFallback"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const arrayString = (
 	entries:

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

@@ -2,7 +2,7 @@ import * as t from "io-ts"
 import { NumberFromString } from "io-ts-types/lib/NumberFromString"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const NumberConfig = t.exact(
 	t.partial({

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

@@ -2,7 +2,7 @@ import * as t from "io-ts"
 import { NumberFromString } from "io-ts-types/lib/NumberFromString"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const RangeConfig = t.exact(
 	t.partial({

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

@@ -3,10 +3,12 @@ import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
 import ImageConstraint from "../shared/ImageConstraint"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 export const DEFAULT_OPTION = "paragraph"
 
+export type RichTextNodeType =
+	typeof RichTextNodeType[keyof typeof RichTextNodeType]
 export const RichTextNodeType = {
 	heading1: "heading1",
 	heading2: "heading2",

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

@@ -5,7 +5,7 @@ import {
 	StringFromNumber,
 	StringOrNull,
 } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const SelectConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const SeparatorConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const TextConfig = t.exact(
 	t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 
 const TimestampConfig = t.exact(
 	t.partial({

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

@@ -2,7 +2,7 @@ import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
 import NestableWidget from "../nestable/NestableWidget"
-import SlicesTypes from "./SlicesTypes"
+import { SlicesTypes } from "./SlicesTypes"
 
 const CompositeSliceConfig = t.exact(
 	t.partial({

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

@@ -2,7 +2,7 @@ import * as t from "io-ts"
 import { withFallback } from "io-ts-types/lib/withFallback"
 
 import NestableWidget from "../nestable/NestableWidget"
-import SlicesTypes from "./SlicesTypes"
+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"

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

@@ -1,6 +1,6 @@
 import * as t from "io-ts"
 
-import SlicesTypes from "./SlicesTypes"
+import { SlicesTypes } from "./SlicesTypes"
 
 const SharedSliceRef = t.exact(
 	t.type({

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

@@ -1,12 +1,12 @@
 import * as t from "io-ts"
 
 import { StringOrNull } from "../../../validators"
-import WidgetTypes from "../WidgetTypes"
+import { WidgetTypes } from "../WidgetTypes"
 import CompositeSlice from "./CompositeSlice"
 import LegacySlice from "./LegacySlice"
 import { SharedSlice } from "./SharedSlice"
 import SharedSliceRef from "./SharedSliceRef"
-import SlicesTypes from "./SlicesTypes"
+import { SlicesTypes } from "./SlicesTypes"
 
 export const SlicesLabels = t.union([
 	t.record(

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

@@ -1,6 +1,6 @@
-const SlicesTypes = {
+export const SlicesTypes = {
 	Slice: "Slice",
 	SharedSlice: "SharedSlice",
 } as const
 
-export default SlicesTypes
+export type SlicesTypes = typeof SlicesTypes[keyof typeof SlicesTypes]

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

@@ -4,4 +4,4 @@ export * from "./SharedSlice"
 export { default as SharedSliceRef } from "./SharedSliceRef"
 export * as Slice from "./Slice"
 export * as SliceZone from "./Slices"
-export { default as SlicesTypes } from "./SlicesTypes"
+export { SlicesTypes } from "./SlicesTypes"

package/src/documents/widgets/index.ts

@@ -1,7 +1,7 @@
 import { EmptyContentType } from "./EmptyContent"
 import { GroupContentType } from "./GroupContent"
 import { NestableTypes } from "./nestable"
-import { SlicesContent, SlicesContentType } from "./slices/SlicesContent"
+import { SlicesContent, SlicesContentType } from "./slices"
 import StaticWidgetContent from "./StaticWidgetContent"
 import { UIDContentType } from "./UIDContent"
 
@@ -24,7 +24,10 @@ export const WidgetTypes = {
 	slices: SlicesContentType,
 } as const
 
+export type WidgetTypes = typeof WidgetTypes[keyof typeof WidgetTypes]
+
 export type WidgetKey = string
+
 export type WidgetContent = SlicesContent | StaticWidgetContent
 
 export const Widget = {

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

@@ -31,3 +31,5 @@ export const LinksTypes = {
 	ImageLink: ImageLinkType,
 	LinkContent: LinkContentType,
 } as const
+
+export type LinksTypes = typeof LinksTypes[keyof typeof LinksTypes]

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

@@ -19,7 +19,7 @@ export const Meta = t.exact(
 		t.type({
 			start: t.number,
 			end: t.number,
-			type: t.union([RichTextNodeTypeCodec, t.literal('label')]),
+			type: t.union([RichTextNodeTypeCodec, t.literal("label")]),
 		}),
 	]),
 )