@prismicio/types-internal 1.0.0-alpha.1 → 1.1.0

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Slices = exports.DynamicSlices = exports.StaticSlices = exports.slicesReader = exports.DynamicSlicesConfig = exports.StaticSlicesConfig = exports.slicesConfigReader = exports.SlicesLabels = void 0;
 const tslib_1 = require("tslib");
 const t = (0, tslib_1.__importStar)(require("io-ts"));
+const widgets_1 = require("../../../documents/widgets");
 const validators_1 = require("../../../validators");
 const WidgetTypes_1 = require("../WidgetTypes");
 const CompositeSlice_1 = (0, tslib_1.__importDefault)(require("./CompositeSlice"));
@@ -25,7 +26,7 @@ function slicesConfigReader(codec) {
     return t.exact(t.partial({
         label: validators_1.StringOrNull,
         labels: exports.SlicesLabels,
-        choices: t.record(t.string, t.union([LegacySlice_1.default, CompositeSlice_1.default, codec])),
+        choices: t.record(widgets_1.WidgetKey, t.union([LegacySlice_1.default, CompositeSlice_1.default, codec])),
     }));
 }
 exports.slicesConfigReader = slicesConfigReader;

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

@@ -1,4 +1,5 @@
-import { SlicesContent } from "./slices/SlicesContent";
+import * as t from "io-ts";
+import { SlicesContent } from "./slices";
 import StaticWidgetContent from "./StaticWidgetContent";
 export * from "./EmptyContent";
 export * from "./GroupContent";
@@ -29,7 +30,8 @@ export declare const WidgetTypes: {
     readonly Separator: "SeparatorContent";
 };
 export declare type WidgetTypes = typeof WidgetTypes[keyof typeof WidgetTypes];
-export declare type WidgetKey = string;
+export declare const WidgetKey: t.Type<string, string, unknown>;
+export declare type WidgetKey = t.TypeOf<typeof WidgetKey>;
 export declare type WidgetContent = SlicesContent | StaticWidgetContent;
 export declare const Widget: {
     fromJson(widgetKey: WidgetKey, widgetValue: unknown, widgetTypes: Map<WidgetKey, string>, widgetPositions: Map<WidgetKey, number>): import("fp-ts/lib/Option").None | import("fp-ts/lib/Option").Some<StaticWidgetContent> | import("fp-ts/lib/Option").Some<SlicesContent>;

package/lib/documents/widgets/index.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Widget = exports.WidgetTypes = exports.StaticWidgetContent = exports.Slices = exports.Nestable = void 0;
+exports.Widget = exports.WidgetKey = exports.WidgetTypes = exports.StaticWidgetContent = exports.Slices = exports.Nestable = void 0;
 const tslib_1 = require("tslib");
+const t = (0, tslib_1.__importStar)(require("io-ts"));
+const function_1 = require("../../validators/function");
 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 +23,15 @@ exports.WidgetTypes = {
     Empty: EmptyContent_1.EmptyContentType,
     UID: UIDContent_1.UIDContentType,
     Group: GroupContent_1.GroupContentType,
-    slices: SlicesContent_1.SlicesContentType,
+    slices: slices_1.SlicesContentType,
 };
+const widgetKeyRegex = new RegExp("^[^<>]+$");
+exports.WidgetKey = (0, function_1.refineType)(t.string, "WidgetKey", (s) => widgetKeyRegex.test(s));
 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/package.json

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

package/src/customtypes/CustomType.ts

@@ -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,13 @@
 import * as t from "io-ts"
 
-import type { SharedSlice } from "./widgets/slices/SharedSlice"
+import { WidgetKey } from "../documents/widgets"
+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(WidgetKey, codec) // WidgetId -> Widget Data
 }
 
 export const StaticSection = sectionReader(StaticWidget)

package/src/customtypes/widgets/Group.ts

@@ -1,5 +1,6 @@
 import * as t from "io-ts"
 
+import { WidgetKey } from "../../documents/widgets"
 import { StringOrNull } from "../../validators"
 import NestableWidget from "./nestable/NestableWidget"
 import { WidgetTypes } from "./WidgetTypes"
@@ -8,7 +9,7 @@ const GroupConfig = t.exact(
 	t.partial({
 		label: StringOrNull,
 		repeat: t.boolean,
-		fields: t.record(t.string, NestableWidget),
+		fields: t.record(WidgetKey, NestableWidget),
 	}),
 )
 type GroupConfig = t.TypeOf<typeof GroupConfig>

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

@@ -1,5 +1,6 @@
 import * as t from "io-ts"
 
+import { WidgetKey } from "../../../documents/widgets"
 import { StringOrNull } from "../../../validators"
 import NestableWidget from "../nestable/NestableWidget"
 import { SlicesTypes } from "./SlicesTypes"
@@ -21,8 +22,8 @@ const CompositeSlice = t.exact(
 			description: t.string,
 			icon: t.string,
 			display: t.string,
-			"non-repeat": t.record(t.string, NestableWidget),
-			repeat: t.record(t.string, NestableWidget),
+			"non-repeat": t.record(WidgetKey, NestableWidget),
+			repeat: t.record(WidgetKey, NestableWidget),
 			config: CompositeSliceConfig,
 		}),
 	]),

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

@@ -1,6 +1,7 @@
 import * as t from "io-ts"
 import { withFallback } from "io-ts-types/lib/withFallback"
 
+import { WidgetKey } from "../../../documents/widgets"
 import NestableWidget from "../nestable/NestableWidget"
 import { SlicesTypes } from "./SlicesTypes"
 
@@ -19,8 +20,8 @@ export const Variation = t.exact(
 		}),
 		t.partial({
 			display: t.string,
-			primary: t.record(t.string, NestableWidget),
-			items: t.record(t.string, NestableWidget),
+			primary: t.record(WidgetKey, NestableWidget),
+			items: t.record(WidgetKey, NestableWidget),
 		}),
 	]),
 )

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

@@ -1,5 +1,6 @@
 import * as t from "io-ts"
 
+import { WidgetKey } from "../../../documents/widgets"
 import { StringOrNull } from "../../../validators"
 import { WidgetTypes } from "../WidgetTypes"
 import CompositeSlice from "./CompositeSlice"
@@ -36,7 +37,7 @@ export function slicesConfigReader<T extends SharedSlice | SharedSliceRef>(
 			label: StringOrNull,
 			labels: SlicesLabels,
 			choices: t.record(
-				t.string,
+				WidgetKey,
 				t.union([LegacySlice, CompositeSlice, codec]),
 			),
 		}),

package/src/documents/widgets/index.ts

@@ -1,7 +1,10 @@
+import * as t from "io-ts"
+
+import { refineType } from "../../validators/function"
 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"
 
@@ -26,7 +29,14 @@ export const WidgetTypes = {
 
 export type WidgetTypes = typeof WidgetTypes[keyof typeof WidgetTypes]
 
-export type WidgetKey = string
+const widgetKeyRegex = new RegExp("^[^<>]+$")
+
+export const WidgetKey = refineType(t.string, "WidgetKey", (s: string) =>
+	widgetKeyRegex.test(s),
+)
+
+export type WidgetKey = t.TypeOf<typeof WidgetKey>
+
 export type WidgetContent = SlicesContent | StaticWidgetContent
 
 export const Widget = {

package/lib/customtypes/Format.d.ts

@@ -1,4 +0,0 @@
-export declare enum Format {
-    Static = "static",
-    Dynamic = "dynamic"
-}

package/lib/customtypes/Format.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Format = void 0;
-var Format;
-(function (Format) {
-    Format["Static"] = "static";
-    Format["Dynamic"] = "dynamic";
-})(Format = exports.Format || (exports.Format = {}));