@prismicio/types-internal 3.17.0-alpha.2 → 3.17.0-pr.144.0c8207f

package/dist/customtypes/CustomType.cjs

@@ -0,0 +1,179 @@
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+const require_StringOrNull = require('../validators/StringOrNull.cjs');
+require('../validators/index.cjs');
+const require_Section = require('./Section.cjs');
+let io_ts = require("io-ts");
+io_ts = require_runtime.__toESM(io_ts);
+let fp_ts_lib_Either = require("fp-ts/lib/Either");
+let io_ts_types_lib_withFallback = require("io-ts-types/lib/withFallback");
+
+//#region src/customtypes/CustomType.ts
+const CustomTypeFormat = {
+	page: "page",
+	custom: "custom"
+};
+var CustomTypeSlicesError = class extends Error {
+	slices;
+	message;
+	constructor(slices) {
+		super();
+		this.slices = slices;
+		this.message = this._formatError(slices);
+	}
+	_formatError(slicesRefs) {
+		return `The following slices doesn't exists in your Prismic repository:
+${slicesRefs.map((ref) => `\t - ${ref}`).join("\n")}
+`;
+	}
+};
+function customTypeReader(codec) {
+	return io_ts.exact(io_ts.intersection([io_ts.type({
+		id: io_ts.string,
+		label: require_StringOrNull.default,
+		repeatable: (0, io_ts_types_lib_withFallback.withFallback)(io_ts.boolean, true),
+		json: io_ts.record(io_ts.string, codec),
+		status: (0, io_ts_types_lib_withFallback.withFallback)(io_ts.boolean, true)
+	}), io_ts.partial({ format: (0, io_ts_types_lib_withFallback.withFallback)(io_ts.keyof(CustomTypeFormat), "custom") })]));
+}
+const StaticCustomType = customTypeReader(require_Section.StaticSection);
+const CustomType = customTypeReader(require_Section.DynamicSection);
+function flattenWidgets(customType) {
+	return Object.entries(customType.json).reduce((acc, [, section]) => {
+		const sectionWidgets = Object.entries(section);
+		return acc.concat(sectionWidgets);
+	}, []);
+}
+function flattenSections(customType) {
+	return Object.entries(customType.json).reduce((acc, [, section]) => {
+		const sectionWidgets = Object.entries(section);
+		return acc.concat(sectionWidgets);
+	}, []);
+}
+function _retrieveSharedSlicesRef(customType) {
+	return flattenWidgets(customType).filter(([, widget]) => widget.type === "Slices").reduce((acc, [, slicezone]) => {
+		const sharedRefs = Object.entries(slicezone.config && slicezone.config.choices ? slicezone.config.choices : {}).filter(([, slice]) => slice.type === "SharedSlice").map(([key]) => key);
+		return acc.concat(sharedRefs);
+	}, []);
+}
+function _mapSharedSlicesRefs(customType) {
+	const refs = _retrieveSharedSlicesRef(customType);
+	return function(mapFn) {
+		return refs.map(mapFn);
+	};
+}
+function toStatic(customType, sharedSlices) {
+	const json = Object.entries(customType.json).reduce((acc, [sectionKey, dynSection]) => {
+		return {
+			...acc,
+			[sectionKey]: require_Section.Sections.toStatic(dynSection, sharedSlices)
+		};
+	}, {});
+	return {
+		...customType,
+		json
+	};
+}
+function validateSlices(customType, sharedSlices) {
+	const missingSlices = _mapSharedSlicesRefs(customType)((ref) => {
+		if (!sharedSlices.get(ref)) return ref;
+	}).filter(Boolean);
+	if (missingSlices.length > 0) return (0, fp_ts_lib_Either.left)(new CustomTypeSlicesError(missingSlices));
+	else return (0, fp_ts_lib_Either.right)(customType);
+}
+function collectWidgets(customType, f) {
+	const json = Object.entries(customType.json).reduce((acc, [sectionId, section]) => {
+		const updatedSection = Object.entries(section).reduce((acc, [ref, widget]) => {
+			const updatedWidget = f(ref, widget);
+			if (updatedWidget) return {
+				...acc,
+				[ref]: updatedWidget
+			};
+			return acc;
+		}, {});
+		return {
+			...acc,
+			[sectionId]: updatedSection
+		};
+	}, {});
+	return {
+		...customType,
+		json
+	};
+}
+function filterMissingSharedSlices(customType, sharedSlices) {
+	return collectWidgets(customType, (_widgetId, widget) => {
+		if (widget.type === "Slices") {
+			if (!widget.config || !widget.config.choices) return widget;
+			const choices = Object.entries(widget.config.choices).reduce((acc, [sliceId, sliceValue]) => {
+				if (sliceValue.type === "SharedSlice" && !sharedSlices.get(sliceId)) return acc;
+				return {
+					...acc,
+					[sliceId]: sliceValue
+				};
+			}, {});
+			const config = {
+				...widget.config,
+				choices
+			};
+			return {
+				...widget,
+				config
+			};
+		}
+		return widget;
+	});
+}
+function flattenCustomTypeFields(customType) {
+	return Object.values(customType.json).reduce((acc, tab) => ({
+		...acc,
+		...tab
+	}), {});
+}
+function collectSharedSlices(customType) {
+	return Object.entries(customType.fields).reduce((acc, [, w]) => {
+		if (w.type === "Slices" || w.type === "Choice") return {
+			...acc,
+			...Object.entries(w.config?.choices || {}).reduce((sliceZoneAcc, [sliceKey, sliceModel]) => {
+				return sliceModel.type === "SharedSlice" ? {
+					...sliceZoneAcc,
+					[sliceKey]: sliceModel
+				} : sliceZoneAcc;
+			}, {})
+		};
+		return acc;
+	}, {});
+}
+function traverseCustomType(args) {
+	const { customType, onField } = args;
+	let json;
+	for (const [key, section] of Object.entries(customType.json)) {
+		const newSection = require_Section.traverseSection({
+			path: [key],
+			section,
+			onField
+		});
+		if (newSection !== section) {
+			if (!json) json = { ...customType.json };
+			json[key] = newSection;
+		}
+	}
+	return json ? {
+		...customType,
+		json
+	} : customType;
+}
+
+//#endregion
+exports.CustomType = CustomType;
+exports.CustomTypeFormat = CustomTypeFormat;
+exports.StaticCustomType = StaticCustomType;
+exports.collectSharedSlices = collectSharedSlices;
+exports.collectWidgets = collectWidgets;
+exports.filterMissingSharedSlices = filterMissingSharedSlices;
+exports.flattenCustomTypeFields = flattenCustomTypeFields;
+exports.flattenSections = flattenSections;
+exports.flattenWidgets = flattenWidgets;
+exports.toStatic = toStatic;
+exports.traverseCustomType = traverseCustomType;
+exports.validateSlices = validateSlices;
+//# sourceMappingURL=CustomType.cjs.map

package/dist/customtypes/CustomType.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomType.cjs","names":["t","StringOrNull","StaticSection","DynamicSection","Sections","traverseSection"],"sources":["../../src/customtypes/CustomType.ts"],"sourcesContent":["import type { Either} from \"fp-ts/lib/Either\";\nimport { left, right } from \"fp-ts/lib/Either\"\nimport * as t from \"io-ts\"\nimport { withFallback } from \"io-ts-types/lib/withFallback\"\n\nimport type { Fields } from \"../utils\"\nimport { StringOrNull } from \"../validators\"\nimport { DynamicSection, Sections, StaticSection, traverseSection } from \"./Section\"\nimport type { Group, NestableWidget, NestedGroup, UID } from \"./widgets\"\nimport type { SharedSlice } from \"./widgets/slices/SharedSlice\"\nimport type { DynamicSlice } from \"./widgets/slices/Slice\"\nimport type { DynamicSlices } from \"./widgets/slices/Slices\"\nimport type { DynamicWidget } from \"./widgets/Widget\"\nimport type { StaticWidget } from \"./widgets/Widget\"\n\nexport const CustomTypeFormat = {\n\tpage: \"page\",\n\tcustom: \"custom\",\n}\n\nclass CustomTypeSlicesError extends Error {\n\tslices: Array<string>\n\toverride message: string\n\n\tconstructor(slices: Array<string>) {\n\t\tsuper()\n\t\tthis.slices = slices\n\t\tthis.message = this._formatError(slices)\n\t}\n\n\t_formatError(slicesRefs: Array<string>) {\n\t\tconst slicesMsg = slicesRefs.map((ref) => `\\t - ${ref}`)\n\t\treturn `The following slices doesn't exists in your Prismic repository:\n${slicesMsg.join(\"\\n\")}\n`\n\t}\n}\n\nfunction customTypeReader<T extends StaticSection | DynamicSection>(codec: t.Type<T, unknown>) {\n\treturn t.exact(\n\t\tt.intersection([\n\t\t\tt.type({\n\t\t\t\tid: t.string,\n\t\t\t\tlabel: StringOrNull,\n\t\t\t\trepeatable: withFallback(t.boolean, true),\n\t\t\t\tjson: t.record(t.string, codec), //tab name => tab data\n\t\t\t\tstatus: withFallback(t.boolean, true),\n\t\t\t}),\n\t\t\tt.partial({\n\t\t\t\tformat: withFallback(t.keyof(CustomTypeFormat), \"custom\"),\n\t\t\t}),\n\t\t]),\n\t)\n}\n\nexport const StaticCustomType = customTypeReader(StaticSection)\nexport type StaticCustomType = t.TypeOf<typeof StaticCustomType>\n\nexport const CustomType = customTypeReader(DynamicSection)\nexport type CustomType = t.TypeOf<typeof CustomType>\n\nexport function flattenWidgets(customType: CustomType): Array<[string, DynamicWidget]> {\n\treturn Object.entries(customType.json).reduce(\n\t\t(acc: Array<[string, DynamicWidget]>, [, section]: [string, DynamicSection]) => {\n\t\t\tconst sectionWidgets: Array<[string, DynamicWidget]> = Object.entries(section)\n\t\t\treturn acc.concat(sectionWidgets)\n\t\t},\n\t\t[],\n\t)\n}\n\nexport function flattenSections(customType: StaticCustomType): Array<[string, StaticWidget]> {\n\treturn Object.entries(customType.json).reduce(\n\t\t(acc: Array<[string, StaticWidget]>, [, section]: [string, StaticSection]) => {\n\t\t\tconst sectionWidgets: Array<[string, StaticWidget]> = Object.entries(section)\n\t\t\treturn acc.concat(sectionWidgets)\n\t\t},\n\t\t[],\n\t)\n}\n\nfunction _retrieveSharedSlicesRef(customType: CustomType): Array<string> {\n\tconst slicezones = flattenWidgets(customType).filter(\n\t\t([, widget]: [string, DynamicWidget]) => widget.type === \"Slices\",\n\t) as Array<[string, DynamicSlices]>\n\n\tconst allSharedRefs = slicezones.reduce((acc: Array<string>, [, slicezone]) => {\n\t\tconst sharedRefs = Object.entries(\n\t\t\tslicezone.config && slicezone.config.choices ? slicezone.config.choices : {},\n\t\t)\n\t\t\t.filter(([, slice]: [string, DynamicSlice]) => slice.type === \"SharedSlice\")\n\t\t\t.map(([key]) => key)\n\t\treturn acc.concat(sharedRefs)\n\t}, [])\n\n\treturn allSharedRefs\n}\n\nfunction _mapSharedSlicesRefs<A>(customType: CustomType): (mapFn: (ref: string) => A) => Array<A> {\n\tconst refs = _retrieveSharedSlicesRef(customType)\n\n\treturn function (mapFn: (ref: string) => A): Array<A> {\n\t\treturn refs.map(mapFn)\n\t}\n}\n\nexport function toStatic(\n\tcustomType: CustomType,\n\tsharedSlices: Map<string, SharedSlice>,\n): StaticCustomType {\n\tconst json = Object.entries(customType.json).reduce(\n\t\t(acc: { [key: string]: StaticSection }, [sectionKey, dynSection]: [string, DynamicSection]) => {\n\t\t\treturn {\n\t\t\t\t...acc,\n\t\t\t\t[sectionKey]: Sections.toStatic(dynSection, sharedSlices),\n\t\t\t}\n\t\t},\n\t\t{},\n\t)\n\n\treturn { ...customType, json } as StaticCustomType\n}\n\nexport function validateSlices(\n\tcustomType: CustomType,\n\tsharedSlices: Map<string, SharedSlice>,\n): Either<CustomTypeSlicesError, CustomType> {\n\tconst missingSlices = _mapSharedSlicesRefs<string | undefined>(customType)((ref: string) => {\n\t\tconst slice: SharedSlice | undefined = sharedSlices.get(ref)\n\t\tconst isMissing = !slice\n\t\tif (isMissing) return ref\n\t\treturn\n\t}).filter(Boolean) as Array<string>\n\n\tif (missingSlices.length > 0) return left(new CustomTypeSlicesError(missingSlices))\n\telse return right(customType)\n}\n\nexport function collectWidgets(\n\tcustomType: CustomType,\n\tf: (ref: string, widget: DynamicWidget) => DynamicWidget | undefined,\n): CustomType {\n\tconst json = Object.entries(customType.json).reduce(\n\t\t(acc, [sectionId, section]: [string, DynamicSection]) => {\n\t\t\tconst updatedSection = Object.entries(section).reduce((acc, [ref, widget]) => {\n\t\t\t\tconst updatedWidget = f(ref, widget)\n\t\t\t\tif (updatedWidget) {\n\t\t\t\t\treturn { ...acc, [ref]: updatedWidget }\n\t\t\t\t}\n\t\t\t\treturn acc\n\t\t\t}, {})\n\t\t\treturn { ...acc, [sectionId]: updatedSection }\n\t\t},\n\t\t{},\n\t)\n\n\treturn { ...customType, json }\n}\n\nexport function filterMissingSharedSlices(\n\tcustomType: CustomType,\n\tsharedSlices: Map<string, SharedSlice>,\n): CustomType {\n\treturn collectWidgets(customType, (_widgetId, widget) => {\n\t\tif (widget.type === \"Slices\") {\n\t\t\tif (!widget.config || !widget.config.choices) return widget\n\n\t\t\tconst choices = Object.entries(widget.config.choices).reduce(\n\t\t\t\t(acc, [sliceId, sliceValue]: [string, DynamicSlice]) => {\n\t\t\t\t\tif (sliceValue.type === \"SharedSlice\" && !sharedSlices.get(sliceId)) return acc\n\t\t\t\t\treturn { ...acc, [sliceId]: sliceValue }\n\t\t\t\t},\n\t\t\t\t{},\n\t\t\t)\n\n\t\t\tconst config = { ...widget.config, choices }\n\n\t\t\treturn { ...widget, config }\n\t\t}\n\n\t\treturn widget\n\t})\n}\n\nexport function flattenCustomTypeFields(\n\tcustomType: StaticCustomType,\n): Record<string, StaticWidget> {\n\treturn Object.values(customType.json).reduce(\n\t\t(acc, tab) => ({\n\t\t\t...acc,\n\t\t\t...tab,\n\t\t}),\n\t\t{},\n\t)\n}\n\nexport function collectSharedSlices(customType: {\n\tcustomTypeId: string\n\tfields: Record<string, StaticWidget>\n}): Record<string, SharedSlice> {\n\treturn Object.entries(customType.fields).reduce((acc, [, w]) => {\n\t\tif (w.type === \"Slices\" || w.type === \"Choice\") {\n\t\t\treturn {\n\t\t\t\t...acc,\n\t\t\t\t...Object.entries(w.config?.choices || {}).reduce(\n\t\t\t\t\t(sliceZoneAcc, [sliceKey, sliceModel]) => {\n\t\t\t\t\t\treturn sliceModel.type === \"SharedSlice\"\n\t\t\t\t\t\t\t? { ...sliceZoneAcc, [sliceKey]: sliceModel }\n\t\t\t\t\t\t\t: sliceZoneAcc\n\t\t\t\t\t},\n\t\t\t\t\t{},\n\t\t\t\t),\n\t\t\t}\n\t\t}\n\t\treturn acc\n\t}, {})\n}\n\nexport function traverseCustomType<T extends CustomType | StaticCustomType>(args: {\n\tcustomType: T\n\tonField: Fields.OnFieldFn<UID | NestableWidget | Group | NestedGroup>\n}): T {\n\tconst { customType, onField } = args\n\n\tlet json: Record<string, (typeof customType.json)[string]> | undefined\n\tfor (const [key, section] of Object.entries(customType.json)) {\n\t\tconst newSection = traverseSection({\n\t\t\tpath: [key],\n\t\t\tsection,\n\t\t\tonField,\n\t\t})\n\n\t\tif (newSection !== section) {\n\t\t\tif (!json) json = { ...customType.json }\n\t\t\tjson[key] = newSection\n\t\t}\n\t}\n\n\t// returns the traversed model instead of a new one if it didn't change\n\treturn json ? { ...customType, json } : customType\n}\n"],"mappings":";;;;;;;;;;AAeA,MAAa,mBAAmB;CAC/B,MAAM;CACN,QAAQ;CACR;AAED,IAAM,wBAAN,cAAoC,MAAM;CACzC;CACA,AAAS;CAET,YAAY,QAAuB;AAClC,SAAO;AACP,OAAK,SAAS;AACd,OAAK,UAAU,KAAK,aAAa,OAAO;;CAGzC,aAAa,YAA2B;AAEvC,SAAO;EADW,WAAW,KAAK,QAAQ,QAAQ,MAAM,CAE9C,KAAK,KAAK,CAAC;;;;AAKvB,SAAS,iBAA2D,OAA2B;AAC9F,QAAOA,MAAE,MACRA,MAAE,aAAa,CACdA,MAAE,KAAK;EACN,IAAIA,MAAE;EACN,OAAOC;EACP,2DAAyBD,MAAE,SAAS,KAAK;EACzC,MAAMA,MAAE,OAAOA,MAAE,QAAQ,MAAM;EAC/B,uDAAqBA,MAAE,SAAS,KAAK;EACrC,CAAC,EACFA,MAAE,QAAQ,EACT,uDAAqBA,MAAE,MAAM,iBAAiB,EAAE,SAAS,EACzD,CAAC,CACF,CAAC,CACF;;AAGF,MAAa,mBAAmB,iBAAiBE,8BAAc;AAG/D,MAAa,aAAa,iBAAiBC,+BAAe;AAG1D,SAAgB,eAAe,YAAwD;AACtF,QAAO,OAAO,QAAQ,WAAW,KAAK,CAAC,QACrC,KAAqC,GAAG,aAAuC;EAC/E,MAAM,iBAAiD,OAAO,QAAQ,QAAQ;AAC9E,SAAO,IAAI,OAAO,eAAe;IAElC,EAAE,CACF;;AAGF,SAAgB,gBAAgB,YAA6D;AAC5F,QAAO,OAAO,QAAQ,WAAW,KAAK,CAAC,QACrC,KAAoC,GAAG,aAAsC;EAC7E,MAAM,iBAAgD,OAAO,QAAQ,QAAQ;AAC7E,SAAO,IAAI,OAAO,eAAe;IAElC,EAAE,CACF;;AAGF,SAAS,yBAAyB,YAAuC;AAcxE,QAbmB,eAAe,WAAW,CAAC,QAC5C,GAAG,YAAqC,OAAO,SAAS,SACzD,CAEgC,QAAQ,KAAoB,GAAG,eAAe;EAC9E,MAAM,aAAa,OAAO,QACzB,UAAU,UAAU,UAAU,OAAO,UAAU,UAAU,OAAO,UAAU,EAAE,CAC5E,CACC,QAAQ,GAAG,WAAmC,MAAM,SAAS,cAAc,CAC3E,KAAK,CAAC,SAAS,IAAI;AACrB,SAAO,IAAI,OAAO,WAAW;IAC3B,EAAE,CAAC;;AAKP,SAAS,qBAAwB,YAAiE;CACjG,MAAM,OAAO,yBAAyB,WAAW;AAEjD,QAAO,SAAU,OAAqC;AACrD,SAAO,KAAK,IAAI,MAAM;;;AAIxB,SAAgB,SACf,YACA,cACmB;CACnB,MAAM,OAAO,OAAO,QAAQ,WAAW,KAAK,CAAC,QAC3C,KAAuC,CAAC,YAAY,gBAA0C;AAC9F,SAAO;GACN,GAAG;IACF,aAAaC,yBAAS,SAAS,YAAY,aAAa;GACzD;IAEF,EAAE,CACF;AAED,QAAO;EAAE,GAAG;EAAY;EAAM;;AAG/B,SAAgB,eACf,YACA,cAC4C;CAC5C,MAAM,gBAAgB,qBAAyC,WAAW,EAAE,QAAgB;AAG3F,MADkB,CADqB,aAAa,IAAI,IAAI,CAE7C,QAAO;GAErB,CAAC,OAAO,QAAQ;AAElB,KAAI,cAAc,SAAS,EAAG,mCAAY,IAAI,sBAAsB,cAAc,CAAC;KAC9E,oCAAa,WAAW;;AAG9B,SAAgB,eACf,YACA,GACa;CACb,MAAM,OAAO,OAAO,QAAQ,WAAW,KAAK,CAAC,QAC3C,KAAK,CAAC,WAAW,aAAuC;EACxD,MAAM,iBAAiB,OAAO,QAAQ,QAAQ,CAAC,QAAQ,KAAK,CAAC,KAAK,YAAY;GAC7E,MAAM,gBAAgB,EAAE,KAAK,OAAO;AACpC,OAAI,cACH,QAAO;IAAE,GAAG;KAAM,MAAM;IAAe;AAExC,UAAO;KACL,EAAE,CAAC;AACN,SAAO;GAAE,GAAG;IAAM,YAAY;GAAgB;IAE/C,EAAE,CACF;AAED,QAAO;EAAE,GAAG;EAAY;EAAM;;AAG/B,SAAgB,0BACf,YACA,cACa;AACb,QAAO,eAAe,aAAa,WAAW,WAAW;AACxD,MAAI,OAAO,SAAS,UAAU;AAC7B,OAAI,CAAC,OAAO,UAAU,CAAC,OAAO,OAAO,QAAS,QAAO;GAErD,MAAM,UAAU,OAAO,QAAQ,OAAO,OAAO,QAAQ,CAAC,QACpD,KAAK,CAAC,SAAS,gBAAwC;AACvD,QAAI,WAAW,SAAS,iBAAiB,CAAC,aAAa,IAAI,QAAQ,CAAE,QAAO;AAC5E,WAAO;KAAE,GAAG;MAAM,UAAU;KAAY;MAEzC,EAAE,CACF;GAED,MAAM,SAAS;IAAE,GAAG,OAAO;IAAQ;IAAS;AAE5C,UAAO;IAAE,GAAG;IAAQ;IAAQ;;AAG7B,SAAO;GACN;;AAGH,SAAgB,wBACf,YAC+B;AAC/B,QAAO,OAAO,OAAO,WAAW,KAAK,CAAC,QACpC,KAAK,SAAS;EACd,GAAG;EACH,GAAG;EACH,GACD,EAAE,CACF;;AAGF,SAAgB,oBAAoB,YAGJ;AAC/B,QAAO,OAAO,QAAQ,WAAW,OAAO,CAAC,QAAQ,KAAK,GAAG,OAAO;AAC/D,MAAI,EAAE,SAAS,YAAY,EAAE,SAAS,SACrC,QAAO;GACN,GAAG;GACH,GAAG,OAAO,QAAQ,EAAE,QAAQ,WAAW,EAAE,CAAC,CAAC,QACzC,cAAc,CAAC,UAAU,gBAAgB;AACzC,WAAO,WAAW,SAAS,gBACxB;KAAE,GAAG;MAAe,WAAW;KAAY,GAC3C;MAEJ,EAAE,CACF;GACD;AAEF,SAAO;IACL,EAAE,CAAC;;AAGP,SAAgB,mBAA4D,MAGtE;CACL,MAAM,EAAE,YAAY,YAAY;CAEhC,IAAI;AACJ,MAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,KAAK,EAAE;EAC7D,MAAM,aAAaC,gCAAgB;GAClC,MAAM,CAAC,IAAI;GACX;GACA;GACA,CAAC;AAEF,MAAI,eAAe,SAAS;AAC3B,OAAI,CAAC,KAAM,QAAO,EAAE,GAAG,WAAW,MAAM;AACxC,QAAK,OAAO;;;AAKd,QAAO,OAAO;EAAE,GAAG;EAAY;EAAM,GAAG"}