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

package/src/generateTypes.ts

@@ -15,6 +15,7 @@ export type GenerateTypesConfig = {
 	fieldConfigs?: FieldConfigs;
 	clientIntegration?: {
 		includeCreateClientInterface?: boolean;
+		includeContentNamespace?: boolean;
 	};
 };
 
@@ -34,7 +35,7 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 
 	sourceFile.addStatements(BLANK_LINE_IDENTIFIER);
 
-	sourceFile.addTypeAlias({
+	const simplifyTypeAlias = sourceFile.addTypeAlias({
 		name: "Simplify",
 		typeParameters: [
 			{
@@ -77,7 +78,10 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 		}
 	}
 
-	if (config.clientIntegration?.includeCreateClientInterface) {
+	if (
+		config.clientIntegration?.includeCreateClientInterface ||
+		config.clientIntegration?.includeContentNamespace
+	) {
 		sourceFile.addImportDeclaration({
 			moduleSpecifier: "@prismicio/client",
 			namespaceImport: "prismic",
@@ -90,28 +94,55 @@ export const generateTypes = (config: GenerateTypesConfig = {}) => {
 			declarationKind: ModuleDeclarationKind.Module,
 		});
 
-		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.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(),
+					};
+				}),
+			});
+		}
 	}
 
 	return getSourceFileText(sourceFile);

package/src/lib/addInterfacePropertiesForFields.ts

@@ -153,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,
@@ -632,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,
 		});