prismic-ts-codegen 0.1.3-alpha.0 → 0.1.3

package/src/generateTypes.ts

@@ -6,7 +6,7 @@ import { addTypeAliasForCustomType } from "./lib/addTypeAliasForCustomType";
 import { addTypeAliasForSharedSlice } from "./lib/addTypeAliasForSharedSlice";
 import { getSourceFileText } from "./lib/getSourceFileText";
 import { FieldConfigs } from "./types";
-import { pascalCase } from "./lib/pascalCase";
+import { buildTypeName } from "./lib/buildTypeName";
 
 export type GenerateTypesConfig = {
 	customTypeModels?: CustomTypeModel[];
@@ -15,7 +15,6 @@ export type GenerateTypesConfig = {
 	fieldConfigs?: FieldConfigs;
 	clientIntegration?: {
 		includeCreateClientInterface?: boolean;
-		includeContentNamespace?: boolean;
 	};
 };
 
@@ -35,7 +34,7 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 
 	sourceFile.addStatements(BLANK_LINE_IDENTIFIER);
 
-	const simplifyTypeAlias = sourceFile.addTypeAlias({
+	sourceFile.addTypeAlias({
 		name: "Simplify",
 		typeParameters: [
 			{
@@ -60,7 +59,7 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 				name: "AllDocumentTypes",
 				type: config.customTypeModels
 					.map((customTypeModel) =>
-						pascalCase(`${customTypeModel.id} Document`),
+						buildTypeName(customTypeModel.id, "Document"),
 					)
 					.join(" | "),
 				isExported: true,
@@ -78,10 +77,7 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 		}
 	}
 
-	if (
-		config.clientIntegration?.includeCreateClientInterface ||
-		config.clientIntegration?.includeContentNamespace
-	) {
+	if (config.clientIntegration?.includeCreateClientInterface) {
 		sourceFile.addImportDeclaration({
 			moduleSpecifier: "@prismicio/client",
 			namespaceImport: "prismic",
@@ -94,55 +90,28 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 			declarationKind: ModuleDeclarationKind.Module,
 		});
 
-		if (config.clientIntegration.includeCreateClientInterface) {
-			clientModuleDeclaration.addInterface({
-				name: "CreateClient",
-				callSignatures: [
-					{
-						parameters: [
-							{
-								name: "repositoryNameOrEndpoint",
-								type: "string",
-							},
-							{
-								name: "options",
-								type: "prismic.ClientConfig",
-								hasQuestionToken: true,
-							},
-						],
-						returnType:
-							(config.customTypeModels?.length || 0) > 0
-								? "prismic.Client<AllDocumentTypes>"
-								: "prismic.Client",
-					},
-				],
-			});
-		}
-
-		if (config.clientIntegration.includeContentNamespace) {
-			const contentNamespaceDeclaration = clientModuleDeclaration.addModule({
-				name: "Content",
-				declarationKind: ModuleDeclarationKind.Namespace,
-			});
-
-			const exportSymbols = sourceFile
-				.getExportSymbols()
-				.filter((exportSymbol) => {
-					// The Simplify utility type should not
-					// be exported, but it is included in
-					// `getExportSymbols()`'s result.
-					return exportSymbol.getName() !== simplifyTypeAlias.getName();
-				});
-
-			contentNamespaceDeclaration.addExportDeclaration({
-				isTypeOnly: true,
-				namedExports: exportSymbols.map((exportSymbol) => {
-					return {
-						name: exportSymbol.getName(),
-					};
-				}),
-			});
-		}
+		clientModuleDeclaration.addInterface({
+			name: "CreateClient",
+			callSignatures: [
+				{
+					parameters: [
+						{
+							name: "repositoryNameOrEndpoint",
+							type: "string",
+						},
+						{
+							name: "options",
+							type: "prismic.ClientConfig",
+							hasQuestionToken: true,
+						},
+					],
+					returnType:
+						(config.customTypeModels?.length || 0) > 0
+							? "prismic.Client<AllDocumentTypes>"
+							: "prismic.Client",
+				},
+			],
+		});
 	}
 
 	return getSourceFileText(sourceFile);

package/src/lib/addInterfacePropertiesForFields.ts

@@ -11,10 +11,11 @@ import {
 import type { InterfaceDeclaration, SourceFile } from "ts-morph";
 
 import { FieldConfigs, PathElement } from "../types";
+
 import { buildFieldDocs } from "./buildFieldDocs";
-import { buildSharedSliceInterfaceName } from "./buildSharedSliceInterfaceName";
+import { buildSharedSliceInterfaceNamePart } from "./buildSharedSliceInterfaceNamePart";
+import { buildTypeName } from "./buildTypeName";
 import { getHumanReadableFieldPath } from "./getHumanReadableFieldPath";
-import { pascalCase } from "./pascalCase";
 
 type AddInterfacePropertyFromFieldConfig = {
 	id: string;
@@ -362,8 +363,12 @@ const addInterfacePropertyForField = (
 
 		case "Group": {
 			const itemInterface = config.sourceFile.addInterface({
-				name: pascalCase(
-					`${config.path[0].id} Document Data ${config.id} Item`,
+				name: buildTypeName(
+					config.path[0].id,
+					"Document",
+					"Data",
+					config.id,
+					"Item",
 				),
 				docs: [
 					{
@@ -424,7 +429,7 @@ const addInterfacePropertyForField = (
 
 					if (choice.type === CustomTypeModelSliceType.SharedSlice) {
 						choiceInterfaceNames.push(
-							buildSharedSliceInterfaceName({ id: choiceId }),
+							buildSharedSliceInterfaceNamePart({ id: choiceId }),
 						);
 					} else if (choice.type === CustomTypeModelSliceType.Slice) {
 						let primaryInterface: InterfaceDeclaration | undefined;
@@ -433,8 +438,14 @@ const addInterfacePropertyForField = (
 							Object.keys(choice["non-repeat"]).length > 0
 						) {
 							primaryInterface = config.sourceFile.addInterface({
-								name: pascalCase(
-									`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Primary`,
+								name: buildTypeName(
+									config.path[0].id,
+									"Document",
+									"Data",
+									config.id,
+									choiceId,
+									"Slice",
+									"Primary",
 								),
 								docs: [
 									{
@@ -490,8 +501,14 @@ const addInterfacePropertyForField = (
 						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`,
+								name: buildTypeName(
+									config.path[0].id,
+									"Document",
+									"Data",
+									config.id,
+									choiceId,
+									"Slice",
+									"Item",
 								),
 								docs: [
 									{
@@ -544,8 +561,13 @@ const addInterfacePropertyForField = (
 						}
 
 						const sliceType = config.sourceFile.addTypeAlias({
-							name: pascalCase(
-								`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice`,
+							name: buildTypeName(
+								config.path[0].id,
+								"Document",
+								"Data",
+								config.id,
+								choiceId,
+								"Slice",
 							),
 							type: `prismicT.Slice<"${choiceId}", ${
 								primaryInterface
@@ -563,8 +585,12 @@ const addInterfacePropertyForField = (
 			}
 
 			const slicesType = config.sourceFile.addTypeAlias({
-				name: pascalCase(
-					`${config.path[0].id} Document Data ${config.id} Slice`,
+				name: buildTypeName(
+					config.path[0].id,
+					"Document",
+					"Data",
+					config.id,
+					"Slice",
 				),
 				type:
 					choiceInterfaceNames.length > 0

package/src/lib/addTypeAliasForCustomType.ts

@@ -8,7 +8,7 @@ import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants";
 import { FieldConfigs } from "../types";
 
 import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
-import { pascalCase } from "./pascalCase";
+import { buildTypeName } from "./buildTypeName";
 
 const collectCustomTypeFields = (
 	model: CustomTypeModel,
@@ -36,7 +36,7 @@ export const addTypeAliasForCustomType = ({
 	let dataInterface: InterfaceDeclaration | TypeAliasDeclaration;
 	if (hasDataFields) {
 		dataInterface = sourceFile.addInterface({
-			name: pascalCase(`${model.id} Document Data`),
+			name: buildTypeName(model.id, "Document", "Data"),
 			docs: [
 				{
 					description: `Content for ${model.label} documents`,
@@ -65,7 +65,7 @@ export const addTypeAliasForCustomType = ({
 		}
 	} else {
 		dataInterface = sourceFile.addTypeAlias({
-			name: pascalCase(`${model.id} Document Data`),
+			name: buildTypeName(model.id, "Document", "Data"),
 			type: `Record<string, never>`,
 			docs: [
 				{
@@ -76,7 +76,7 @@ export const addTypeAliasForCustomType = ({
 	}
 
 	return sourceFile.addTypeAlias({
-		name: pascalCase(`${model.id} Document`),
+		name: buildTypeName(model.id, "Document"),
 		typeParameters: [
 			{
 				name: "Lang",

package/src/lib/addTypeAliasForSharedSlice.ts

@@ -5,13 +5,14 @@ import type {
 	TypeAliasDeclaration,
 } from "ts-morph";
 
-import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
-import { buildSharedSliceInterfaceName } from "./buildSharedSliceInterfaceName";
-import { pascalCase } from "./pascalCase";
-import { getHumanReadableFieldPath } from "./getHumanReadableFieldPath";
 import { SHARED_SLICES_DOCUMENTATION_URL } from "../constants";
 import { FieldConfigs } from "../types";
 
+import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
+import { buildSharedSliceInterfaceNamePart } from "./buildSharedSliceInterfaceNamePart";
+import { buildTypeName } from "./buildTypeName";
+import { getHumanReadableFieldPath } from "./getHumanReadableFieldPath";
+
 type AddTypeAliasForSharedSliceConfig = {
 	model: SharedSliceModel;
 	sourceFile: SourceFile;
@@ -27,10 +28,10 @@ export const addTypeAliasForSharedSlice = (
 		let primaryInterface: InterfaceDeclaration | undefined;
 		if (variation.primary && Object.keys(variation.primary).length > 0) {
 			primaryInterface = config.sourceFile.addInterface({
-				name: pascalCase(
-					`${buildSharedSliceInterfaceName({ id: config.model.id })} ${
-						variation.id
-					} Primary`,
+				name: buildTypeName(
+					buildSharedSliceInterfaceNamePart({ id: config.model.id }),
+					variation.id,
+					"Primary",
 				),
 				docs: [
 					{
@@ -74,10 +75,10 @@ export const addTypeAliasForSharedSlice = (
 		let itemInterface: InterfaceDeclaration | undefined;
 		if (variation.items && Object.keys(variation.items).length > 0) {
 			itemInterface = config.sourceFile.addInterface({
-				name: pascalCase(
-					`${buildSharedSliceInterfaceName({ id: config.model.id })} ${
-						variation.id
-					} Item`,
+				name: buildTypeName(
+					buildSharedSliceInterfaceNamePart({ id: config.model.id }),
+					variation.id,
+					"Item",
 				),
 				docs: [
 					{
@@ -120,10 +121,9 @@ export const addTypeAliasForSharedSlice = (
 		}
 
 		const variationType = config.sourceFile.addTypeAlias({
-			name: pascalCase(
-				`${buildSharedSliceInterfaceName({
-					id: config.model.id,
-				})} ${variation.id}`,
+			name: buildTypeName(
+				buildSharedSliceInterfaceNamePart({ id: config.model.id }),
+				variation.id,
 			),
 			type: `prismicT.SharedSliceVariation<"${variation.id}", ${
 				primaryInterface
@@ -152,7 +152,7 @@ export const addTypeAliasForSharedSlice = (
 	}
 
 	const variationsType = config.sourceFile.addTypeAlias({
-		name: pascalCase(`${config.model.id} Slice Variation`),
+		name: buildTypeName(config.model.id, "Slice", "Variation"),
 		type:
 			variationTypeNames.length > 0 ? variationTypeNames.join(" | ") : "never",
 		docs: [
@@ -174,10 +174,8 @@ export const addTypeAliasForSharedSlice = (
 	});
 
 	return config.sourceFile.addTypeAlias({
-		name: pascalCase(
-			buildSharedSliceInterfaceName({
-				id: config.model.id,
-			}),
+		name: buildTypeName(
+			buildSharedSliceInterfaceNamePart({ id: config.model.id }),
 		),
 		type: `prismicT.SharedSlice<"${
 			config.model.id

package/src/lib/buildSharedSliceInterfaceNamePart.ts

@@ -0,0 +1,11 @@
+import { pascalCase } from "./pascalCase";
+
+type BuildSharedSliceInterfaceNamePartConfig = {
+	id: string;
+};
+
+export const buildSharedSliceInterfaceNamePart = (
+	config: BuildSharedSliceInterfaceNamePartConfig,
+): string => {
+	return pascalCase(`${config.id} Slice`);
+};

package/src/lib/buildTypeName.ts

@@ -0,0 +1,11 @@
+import { pascalCase } from "./pascalCase";
+
+export const buildTypeName = (...parts: string[]) => {
+	let name = pascalCase(parts.filter(Boolean).join(" "));
+
+	if (/^[0-9]/.test(name) ? "_" : "") {
+		name = `_${name}`;
+	}
+
+	return name;
+};

package/src/lib/buildSharedSliceInterfaceName.ts

@@ -1,11 +0,0 @@
-import { pascalCase } from "./pascalCase";
-
-type BuildSharedSliceInterfaceNameConfig = {
-	id: string;
-};
-
-export const buildSharedSliceInterfaceName = (
-	config: BuildSharedSliceInterfaceNameConfig,
-): string => {
-	return pascalCase(`${config.id} Slice`);
-};