prismic-ts-codegen 0.0.7 → 0.1.2

package/src/lib/addInterfacePropertiesForFields.ts

@@ -132,7 +132,10 @@ const addInterfacePropertyForField = (
 		}
 
 		case "Image": {
-			if (config.model.config.thumbnails.length > 0) {
+			if (
+				config.model.config?.thumbnails &&
+				config.model.config.thumbnails.length > 0
+			) {
 				const thumbnailNames = config.model.config.thumbnails
 					.map((thumbnail) => `"${thumbnail.name}"`)
 					.join(" | ");
@@ -150,7 +153,7 @@ const addInterfacePropertyForField = (
 			} else {
 				config.interface.addProperty({
 					name: config.id,
-					type: "prismicT.ImageField<null>",
+					type: "prismicT.ImageField<never>",
 					docs: buildFieldDocs({
 						id: config.id,
 						model: config.model,
@@ -164,10 +167,11 @@ const addInterfacePropertyForField = (
 		}
 
 		case "IntegrationFields": {
-			const catalogType =
-				config.fieldConfigs.integrationFields?.catalogTypes?.[
-					config.model.config.catalog
-				];
+			const catalogType = config.model.config?.catalog
+				? config.fieldConfigs.integrationFields?.catalogTypes?.[
+						config.model.config.catalog
+				  ]
+				: undefined;
 
 			config.interface.addProperty({
 				name: config.id,
@@ -186,11 +190,13 @@ const addInterfacePropertyForField = (
 		}
 
 		case "Link": {
-			switch (config.model.config.select) {
+			switch (config.model.config?.select) {
 				case CustomTypeModelLinkSelectType.Document: {
+					config.model.config;
 					config.interface.addProperty({
 						name: config.id,
 						type:
+							"customtypes" in config.model.config &&
 							config.model.config.customtypes &&
 							config.model.config.customtypes.length > 0
 								? `prismicT.RelationField<${config.model.config.customtypes
@@ -257,7 +263,9 @@ const addInterfacePropertyForField = (
 
 		case "StructuredText": {
 			const isTitleField =
+				config.model.config &&
 				"single" in config.model.config &&
+				config.model.config.single &&
 				config.model.config.single
 					.split(",")
 					.every((blockType) => /heading/.test(blockType));
@@ -290,15 +298,15 @@ const addInterfacePropertyForField = (
 		}
 
 		case "Select": {
-			const options = config.model.config.options
-				.map((option) => `"${option}"`)
+			const options = config.model.config?.options
+				?.map((option) => `"${option}"`)
 				.join(" | ");
-			const hasDefault = Boolean(config.model.config.default_value);
+			const hasDefault = Boolean(config.model.config?.default_value);
 
 			if (hasDefault) {
 				config.interface.addProperty({
 					name: config.id,
-					type: `prismicT.SelectField<${options}, "filled">`,
+					type: `prismicT.SelectField<${options || "string"}, "filled">`,
 					docs: buildFieldDocs({
 						id: config.id,
 						model: config.model,
@@ -376,19 +384,22 @@ const addInterfacePropertyForField = (
 				],
 				isExported: true,
 			});
-			addInterfacePropertiesForFields({
-				interface: itemInterface,
-				sourceFile: config.sourceFile,
-				fields: config.model.config.fields,
-				path: [
-					...config.path,
-					{
-						id: config.id,
-						model: config.model,
-					},
-				],
-				fieldConfigs: config.fieldConfigs,
-			});
+
+			if (config.model.config?.fields) {
+				addInterfacePropertiesForFields({
+					interface: itemInterface,
+					sourceFile: config.sourceFile,
+					fields: config.model.config.fields,
+					path: [
+						...config.path,
+						{
+							id: config.id,
+							model: config.model,
+						},
+					],
+					fieldConfigs: config.fieldConfigs,
+				});
+			}
 
 			config.interface.addProperty({
 				name: config.id,
@@ -407,140 +418,147 @@ const addInterfacePropertyForField = (
 		case "Slices": {
 			const choiceInterfaceNames: string[] = [];
 
-			for (const choiceId in config.model.config.choices) {
-				const choice = config.model.config.choices[choiceId];
-
-				if (choice.type === CustomTypeModelSliceType.SharedSlice) {
-					choiceInterfaceNames.push(
-						buildSharedSliceInterfaceName({ id: choiceId }),
-					);
-				} else if (choice.type === CustomTypeModelSliceType.Slice) {
-					let primaryInterface: InterfaceDeclaration | undefined;
-					if (Object.keys(choice["non-repeat"]).length > 0) {
-						primaryInterface = config.sourceFile.addInterface({
-							name: pascalCase(
-								`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Primary`,
-							),
-							docs: [
-								{
-									description: (writer) => {
-										const humanReadablePath = getHumanReadableFieldPath({
-											path: [
-												...config.path,
-												{
-													id: config.id,
-													model: config.model,
-												},
-												{
-													id: choiceId,
-													model: choice,
-												},
-												{
-													id: "primary",
-													label: "Primary",
-												},
-											],
-										});
-
-										writer.writeLine(`Primary content in ${humanReadablePath}`);
+			if (config.model.config?.choices) {
+				for (const choiceId in config.model.config.choices) {
+					const choice = config.model.config.choices[choiceId];
+
+					if (choice.type === CustomTypeModelSliceType.SharedSlice) {
+						choiceInterfaceNames.push(
+							buildSharedSliceInterfaceName({ id: choiceId }),
+						);
+					} else if (choice.type === CustomTypeModelSliceType.Slice) {
+						let primaryInterface: InterfaceDeclaration | undefined;
+						if (
+							choice["non-repeat"] &&
+							Object.keys(choice["non-repeat"]).length > 0
+						) {
+							primaryInterface = config.sourceFile.addInterface({
+								name: pascalCase(
+									`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Primary`,
+								),
+								docs: [
+									{
+										description: (writer) => {
+											const humanReadablePath = getHumanReadableFieldPath({
+												path: [
+													...config.path,
+													{
+														id: config.id,
+														model: config.model,
+													},
+													{
+														id: choiceId,
+														model: choice,
+													},
+													{
+														id: "primary",
+														label: "Primary",
+													},
+												],
+											});
+
+											writer.writeLine(
+												`Primary content in ${humanReadablePath}`,
+											);
+										},
 									},
-								},
-							],
-						});
-						addInterfacePropertiesForFields({
-							interface: primaryInterface,
-							sourceFile: config.sourceFile,
-							fields: choice["non-repeat"],
-							path: [
-								...config.path,
-								{
-									id: config.id,
-									model: config.model,
-								},
-								{
-									id: choiceId,
-									model: choice,
-								},
-								{
-									id: "primary",
-									label: "Primary",
-								},
-							],
-							fieldConfigs: config.fieldConfigs,
-						});
-					}
+								],
+							});
+							addInterfacePropertiesForFields({
+								interface: primaryInterface,
+								sourceFile: config.sourceFile,
+								fields: choice["non-repeat"],
+								path: [
+									...config.path,
+									{
+										id: config.id,
+										model: config.model,
+									},
+									{
+										id: choiceId,
+										model: choice,
+									},
+									{
+										id: "primary",
+										label: "Primary",
+									},
+								],
+								fieldConfigs: config.fieldConfigs,
+							});
+						}
+
+						let itemInterface: InterfaceDeclaration | undefined;
+						if (choice.repeat && Object.keys(choice.repeat).length > 0) {
+							itemInterface = config.sourceFile.addInterface({
+								name: pascalCase(
+									`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Item`,
+								),
+								docs: [
+									{
+										description: (writer) => {
+											const humanReadablePath = getHumanReadableFieldPath({
+												path: [
+													...config.path,
+													{
+														id: config.id,
+														model: config.model,
+													},
+													{
+														id: choiceId,
+														model: choice,
+													},
+													{
+														id: "items",
+														label: "Items",
+													},
+												],
+											});
+
+											writer.writeLine(`Item in ${humanReadablePath}`);
+										},
+									},
+								],
+								isExported: true,
+							});
+							addInterfacePropertiesForFields({
+								interface: itemInterface,
+								sourceFile: config.sourceFile,
+								fields: choice.repeat,
+								path: [
+									...config.path,
+									{
+										id: config.id,
+										model: config.model,
+									},
+									{
+										id: choiceId,
+										model: choice,
+									},
+									{
+										id: "items",
+										label: "Items",
+									},
+								],
+								fieldConfigs: config.fieldConfigs,
+							});
+						}
 
-					let itemInterface: InterfaceDeclaration | undefined;
-					if (Object.keys(choice.repeat).length > 0) {
-						itemInterface = config.sourceFile.addInterface({
+						const sliceType = config.sourceFile.addTypeAlias({
 							name: pascalCase(
-								`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Item`,
+								`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice`,
 							),
-							docs: [
-								{
-									description: (writer) => {
-										const humanReadablePath = getHumanReadableFieldPath({
-											path: [
-												...config.path,
-												{
-													id: config.id,
-													model: config.model,
-												},
-												{
-													id: choiceId,
-													model: choice,
-												},
-												{
-													id: "items",
-													label: "Items",
-												},
-											],
-										});
-
-										writer.writeLine(`Item in ${humanReadablePath}`);
-									},
-								},
-							],
+							type: `prismicT.Slice<"${choiceId}", ${
+								primaryInterface
+									? `Simplify<${primaryInterface.getName()}>`
+									: "Record<string, never>"
+							}, ${
+								itemInterface ? `Simplify<${itemInterface.getName()}>` : "never"
+							}>`,
 							isExported: true,
 						});
-						addInterfacePropertiesForFields({
-							interface: itemInterface,
-							sourceFile: config.sourceFile,
-							fields: choice.repeat,
-							path: [
-								...config.path,
-								{
-									id: config.id,
-									model: config.model,
-								},
-								{
-									id: choiceId,
-									model: choice,
-								},
-								{
-									id: "items",
-									label: "Items",
-								},
-							],
-							fieldConfigs: config.fieldConfigs,
-						});
-					}
 
-					const sliceType = config.sourceFile.addTypeAlias({
-						name: pascalCase(
-							`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice`,
-						),
-						type: `prismicT.Slice<"${choiceId}", ${
-							primaryInterface
-								? `Simplify<${primaryInterface.getName()}>`
-								: "Record<string, never>"
-						}, ${
-							itemInterface ? `Simplify<${itemInterface.getName()}>` : "never"
-						}>`,
-						isExported: true,
-					});
-
-					choiceInterfaceNames.push(sliceType.getName());
+						choiceInterfaceNames.push(sliceType.getName());
+					}
 				}
 			}
 
@@ -614,7 +632,7 @@ export const addInterfacePropertiesForFields = (
 	for (const name in config.fields) {
 		addInterfacePropertyForField({
 			...config,
-			id: name.includes("-") ? `"${name}"` : name,
+			id: name.includes("-") || /^[0-9]/.test(name) ? `"${name}"` : name,
 			model: config.fields[name],
 			tabName: config.tabName,
 		});

package/src/lib/addTypeAliasForSharedSlice.ts

@@ -25,7 +25,7 @@ export const addTypeAliasForSharedSlice = (
 
 	for (const variation of config.model.variations) {
 		let primaryInterface: InterfaceDeclaration | undefined;
-		if (Object.keys(variation.primary).length > 0) {
+		if (variation.primary && Object.keys(variation.primary).length > 0) {
 			primaryInterface = config.sourceFile.addInterface({
 				name: pascalCase(
 					`${buildSharedSliceInterfaceName({ id: config.model.id })} ${
@@ -72,7 +72,7 @@ export const addTypeAliasForSharedSlice = (
 		}
 
 		let itemInterface: InterfaceDeclaration | undefined;
-		if (Object.keys(variation.items).length > 0) {
+		if (variation.items && Object.keys(variation.items).length > 0) {
 			itemInterface = config.sourceFile.addInterface({
 				name: pascalCase(
 					`${buildSharedSliceInterfaceName({ id: config.model.id })} ${

package/src/lib/buildFieldDocs.ts

@@ -43,13 +43,14 @@ export const buildFieldDocs = (
 				});
 
 				const placeholder =
+					config.model.config &&
 					"placeholder" in config.model.config &&
 					config.model.config.placeholder
 						? config.model.config.placeholder
 						: `*None*`;
 
 				const defaultValue =
-					"default_value" in config.model.config
+					config.model.config && "default_value" in config.model.config
 						? config.model.config.default_value
 						: undefined;
 

package/src/lib/getFieldDocumentationURL.ts

@@ -8,6 +8,8 @@ type GetFieldDocumentationURLConfig = {
 
 export const getFieldDocumentationURL = (
 	config: GetFieldDocumentationURLConfig,
-): string => {
-	return FIELD_DOCUMENTATION_URLS[config.model.type];
+): string | undefined => {
+	return FIELD_DOCUMENTATION_URLS[
+		config.model.type as keyof typeof FIELD_DOCUMENTATION_URLS
+	];
 };

package/src/lib/getHumanReadableFieldType.ts

@@ -11,7 +11,9 @@ export const getHumanReadableFieldType = (
 	switch (config.model.type) {
 		case "StructuredText": {
 			const isTitleField =
+				config.model.config &&
 				"single" in config.model.config &&
+				config.model.config.single &&
 				config.model.config.single
 					.split(",")
 					.every((blockType) => /heading/.test(blockType));
@@ -20,11 +22,15 @@ export const getHumanReadableFieldType = (
 		}
 
 		case "IntegrationFields": {
-			return `Integration Fields (Catalog: \`${config.model.config.catalog}\`)`;
+			const catalog = config.model.config?.catalog;
+
+			return `Integration Fields (Catalog: ${
+				catalog ? `\`${catalog}\`` : "*unknown*"
+			})`;
 		}
 
 		case "Link": {
-			switch (config.model.config.select) {
+			switch (config.model.config?.select) {
 				case CustomTypeModelLinkSelectType.Document: {
 					return "Content Relationship";
 				}

package/src/lib/getHumanReadableModelName.ts

@@ -23,18 +23,20 @@ export const getHumanReadableModelName = (
 	config: GetModelHumanNameConfig,
 ): string => {
 	if (isCustomTypeModel(config.model)) {
-		return config.model.label;
+		return config.model.label || config.model.id;
 	} else if (isSharedSliceModel(config.model)) {
 		return config.model.name;
-	} else if (
-		isCustomTypeModelField(config.model) &&
-		"label" in config.model.config
-	) {
-		return config.model.config.label;
+	} else if (isCustomTypeModelField(config.model)) {
+		if (config.model.config && "label" in config.model.config) {
+			// Non-Slice Zone fields
+			return config.model.config.label || config.id;
+		} else if (config.model.config && "fieldset" in config.model) {
+			// Slice Zone
+			return config.model.fieldset || config.id;
+		}
 	} else if (isCustomTypeModelSlice(config.model)) {
-		return config.model.fieldset;
-	} else {
-		// Slice Zone
-		return `Slice Zone (\`${config.id}\`)`;
+		return config.model.fieldset || config.id;
 	}
+
+	return `\`${config.id}\``;
 };

package/src/lib/hasOwnProperty.ts

@@ -0,0 +1,15 @@
+/**
+ * Determines if an object contains a given property. It augments the provided
+ * object's type to include the property.
+ *
+ * @remarks
+ * This function is only necessary because TypeScript does not narrow a type
+ * after using the `in` operator on `object`.
+ * @returns `true` if `obj` contains a `prop` property, `false` otherwise.
+ */
+export const hasOwnProperty = <X extends object, Y extends PropertyKey>(
+	obj: X,
+	prop: Y,
+): obj is X & Record<Y, unknown> => {
+	return obj.hasOwnProperty(prop);
+};

package/src/lib/isCustomTypeModelField.ts

@@ -3,10 +3,5 @@ import type { CustomTypeModelField } from "@prismicio/types";
 export const isCustomTypeModelField = (
 	model: unknown,
 ): model is CustomTypeModelField => {
-	return (
-		typeof model === "object" &&
-		model !== null &&
-		"type" in model &&
-		"config" in model
-	);
+	return typeof model === "object" && model !== null && "type" in model;
 };

package/src/lib/isCustomTypeModelSlice.ts

@@ -1,4 +1,9 @@
-import type { CustomTypeModelSlice } from "@prismicio/types";
+import {
+	CustomTypeModelSlice,
+	CustomTypeModelSliceType,
+} from "@prismicio/types";
+
+import { hasOwnProperty } from "./hasOwnProperty";
 
 export const isCustomTypeModelSlice = (
 	model: unknown,
@@ -6,7 +11,7 @@ export const isCustomTypeModelSlice = (
 	return (
 		typeof model === "object" &&
 		model !== null &&
-		"non-repeat" in model &&
-		"repeat" in model
+		hasOwnProperty(model, "type") &&
+		model.type === CustomTypeModelSliceType.Slice
 	);
 };

package/src/lib/isSharedSliceModel.ts

@@ -1,7 +1,14 @@
-import type { SharedSliceModel } from "@prismicio/types";
+import { CustomTypeModelSliceType, SharedSliceModel } from "@prismicio/types";
+
+import { hasOwnProperty } from "./hasOwnProperty";
 
 export const isSharedSliceModel = (
 	model: unknown,
 ): model is SharedSliceModel => {
-	return typeof model === "object" && model !== null && "variations" in model;
+	return (
+		typeof model === "object" &&
+		model !== null &&
+		hasOwnProperty(model, "type") &&
+		model.type === CustomTypeModelSliceType.SharedSlice
+	);
 };