prismic-ts-codegen 0.1.28 → 0.1.29

package/src/cli/constants.ts

@@ -1,2 +1 @@
-export const NON_EDITABLE_FILE_HEADER =
-	"// Code generated by prismic-ts-codegen. DO NOT EDIT.";
+export const NON_EDITABLE_FILE_HEADER = "// Code generated by prismic-ts-codegen. DO NOT EDIT.";

package/src/cli/index.ts

@@ -1,10 +1,10 @@
-import { stripIndent } from "common-tags";
 import { existsSync, writeFileSync } from "fs";
-import meow from "meow";
 import { resolve as resolvePath } from "path";
 
-import { detectTypesProvider, generateTypes } from "../index";
+import { stripIndent } from "common-tags";
+import meow from "meow";
 
+import { detectTypesProvider, generateTypes } from "../index";
 import { configSchema } from "./configSchema";
 import { NON_EDITABLE_FILE_HEADER } from "./constants";
 import { loadConfig } from "./loadConfig";
@@ -74,13 +74,12 @@ const main = async () => {
 	} else {
 		const unvalidatedConfig = loadConfig({ path: cli.flags.config });
 
-		const { value: config, error } = configSchema.validate(unvalidatedConfig);
+		const result = configSchema.safeParse(unvalidatedConfig);
 
-		if (config && !error) {
+		if (result.success) {
+			const config = result.data;
 			const { customTypeModels, sharedSliceModels } = await loadModels({
-				localPaths: Array.isArray(config.models)
-					? config.models
-					: config.models?.files,
+				localPaths: Array.isArray(config.models) ? config.models : config.models?.files,
 				repositoryName: config.repositoryName,
 				customTypesAPIToken: config.customTypesAPIToken,
 				fetchFromRepository:
@@ -90,9 +89,7 @@ const main = async () => {
 			});
 
 			const localeIDs = await loadLocaleIDs({
-				localeIDs: Array.isArray(config.locales)
-					? config.locales
-					: config.locales?.ids,
+				localeIDs: Array.isArray(config.locales) ? config.locales : config.locales?.ids,
 				repositoryName: config.repositoryName,
 				accessToken: config.accessToken,
 				fetchFromRepository:
@@ -101,15 +98,11 @@ const main = async () => {
 					config.locales.fetchFromRepository,
 			});
 
-			const typesProvider =
-				config.typesProvider || (await detectTypesProvider());
+			const typesProvider = config.typesProvider || (await detectTypesProvider());
 
 			const hasCustomTypeModels = customTypeModels.length > 0;
 
-			if (
-				config.clientIntegration?.includeCreateClientInterface &&
-				!hasCustomTypeModels
-			) {
+			if (config.clientIntegration?.includeCreateClientInterface && !hasCustomTypeModels) {
 				console.info(
 					"[INFO]: prismic-ts-codegen was configured to automatically integrate with `@prismicio/client`, but the integration was not generated because no Custom Type models were found. Automatic integration requires at least one Custom Type model.",
 				);
@@ -122,10 +115,9 @@ const main = async () => {
 				fieldConfigs: config.fields,
 				clientIntegration: {
 					includeCreateClientInterface: hasCustomTypeModels
-						? config.clientIntegration?.includeCreateClientInterface ?? true
+						? (config.clientIntegration?.includeCreateClientInterface ?? true)
 						: false,
-					includeContentNamespace:
-						config.clientIntegration?.includeContentNamespace ?? true,
+					includeContentNamespace: config.clientIntegration?.includeContentNamespace ?? true,
 				},
 				typesProvider,
 			});
@@ -140,10 +132,8 @@ const main = async () => {
 				process.stdout.write(types + "\n");
 			}
 		} else {
-			if (error) {
-				console.error(error.message);
-				process.exit(1);
-			}
+			console.error(result.error.message);
+			process.exit(1);
 		}
 	}
 };

package/src/cli/loadConfig.ts

@@ -1,23 +1,19 @@
 import { existsSync } from "fs";
-import _jiti from "jiti";
 import { resolve as resolvePath } from "path";
 
-import type { Config } from "./types";
+import _jiti from "jiti";
+
+import type { Config } from "./configSchema";
 
 const jiti = _jiti(process.cwd());
 
 const loadModuleWithJiti = <TModule>(id: string): TModule => {
 	const mod = jiti(id) as TModule | { default: TModule };
 
-	return typeof mod === "object" && mod !== null && "default" in mod
-		? mod.default
-		: mod;
+	return typeof mod === "object" && mod !== null && "default" in mod ? mod.default : mod;
 };
 
-const DEFAULT_CONFIG_PATHS = [
-	"prismicCodegen.config.ts",
-	"prismicCodegen.config.js",
-];
+const DEFAULT_CONFIG_PATHS = ["prismicCodegen.config.ts", "prismicCodegen.config.js"];
 
 type LoadConfigConfig = {
 	path?: string;

package/src/cli/loadLocaleIDs.ts

@@ -12,9 +12,7 @@ type LoadLocalesConfig =
 			fetchFromRepository?: boolean;
 	  };
 
-export const loadLocaleIDs = async (
-	config: LoadLocalesConfig,
-): Promise<string[]> => {
+export const loadLocaleIDs = async (config: LoadLocalesConfig): Promise<string[]> => {
 	const localeIDs = new Set<string>(config.localeIDs || []);
 
 	if ("repositoryName" in config && config.fetchFromRepository) {

package/src/cli/loadModels.ts

@@ -1,7 +1,8 @@
-import * as prismicCT from "@prismicio/custom-types-client";
+import { readFileSync } from "fs";
+
 import type { CustomTypeModel, SharedSliceModel } from "@prismicio/client";
+import * as prismicCT from "@prismicio/custom-types-client";
 import fg from "fast-glob";
-import { readFileSync } from "fs";
 import fetch from "node-fetch";
 
 const isCustomTypeModel = (input: unknown): input is CustomTypeModel => {
@@ -38,9 +39,7 @@ type LoadModelsReturnType = {
 	sharedSliceModels: SharedSliceModel[];
 };
 
-export const loadModels = async (
-	config: LoadModelsConfig,
-): Promise<LoadModelsReturnType> => {
+export const loadModels = async (config: LoadModelsConfig): Promise<LoadModelsReturnType> => {
 	const customTypeModels: Record<string, CustomTypeModel> = {};
 	const sharedSliceModels: Record<string, SharedSliceModel> = {};
 
@@ -52,11 +51,10 @@ export const loadModels = async (
 		});
 
 		if (config.fetchFromRepository) {
-			const [remoteCustomTypeModels, remoteSharedSliceModels] =
-				await Promise.all([
-					customTypesClient.getAllCustomTypes(),
-					customTypesClient.getAllSharedSlices(),
-				]);
+			const [remoteCustomTypeModels, remoteSharedSliceModels] = await Promise.all([
+				customTypesClient.getAllCustomTypes(),
+				customTypesClient.getAllSharedSlices(),
+			]);
 
 			for (const customTypeModel of remoteCustomTypeModels) {
 				customTypeModels[customTypeModel.id] = customTypeModel;

package/src/constants.ts

@@ -1,7 +1,6 @@
 import type { CustomTypeModelFieldType } from "@prismicio/client";
 
-export const CUSTOM_TYPES_DOCUMENTATION_URL =
-	"https://prismic.io/docs/content-modeling";
+export const CUSTOM_TYPES_DOCUMENTATION_URL = "https://prismic.io/docs/content-modeling";
 
 export const SHARED_SLICES_DOCUMENTATION_URL = "https://prismic.io/docs/slices";
 

package/src/detectTypesProvider.ts

@@ -1,6 +1,6 @@
 import { createRequire } from "node:module";
 
-import { TypesProvider } from "./generateTypes";
+import type { TypesProvider } from "./generateTypes";
 
 export type DetectTypesProviderConfig = {
 	cwd?: string;
@@ -10,9 +10,8 @@ export type DetectTypesProviderConfig = {
  * Detects which types provider should be used for a project.
  *
  * @param config - Configures the detection.
- *
  * @returns The types provider identifier to use, or `undefined` if on cannot be
- *   determined.
+ * determined.
  */
 export const detectTypesProvider = async (
 	config: DetectTypesProviderConfig = {},
@@ -22,11 +21,7 @@ export const detectTypesProvider = async (
 	const require = createRequire(cwd.endsWith("/") ? cwd : cwd + "/");
 
 	try {
-		if (
-			Number.parseInt(
-				require("@prismicio/client/package.json").version.split(".")[0],
-			) >= 7
-		) {
+		if (Number.parseInt(require("@prismicio/client/package.json").version.split(".")[0]) >= 7) {
 			return "@prismicio/client";
 		}
 	} catch {

package/src/generateTypes.ts

@@ -7,8 +7,7 @@ import { addSection } from "./lib/addSection";
 import { buildCustomTypeType } from "./lib/buildCustomTypeType";
 import { buildSharedSliceType } from "./lib/buildSharedSliceType";
 import { buildUnion } from "./lib/buildUnion";
-
-import { FieldConfigs } from "./types";
+import type { FieldConfigs } from "./types";
 
 export type TypesProvider = "@prismicio/client" | "@prismicio/types";
 
@@ -47,17 +46,11 @@ export function generateTypes(config: GenerateTypesConfig = {}): string {
 
 			// This import declaration would be a duplicate if the types
 			// provider is @prismicio/client.
-			code = addLine(
-				`import type * as ${clientImportName} from "@prismicio/client";`,
-				code,
-			);
+			code = addLine(`import type * as ${clientImportName} from "@prismicio/client";`, code);
 		}
 	}
 
-	code = addSection(
-		`type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };`,
-		code,
-	);
+	code = addSection(`type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };`, code);
 
 	code = addSection(
 		`

package/src/index.ts

@@ -6,6 +6,5 @@ export type { DetectTypesProviderConfig } from "./detectTypesProvider";
 
 // The CLI configuration type is exported at the root level for ease of access.
 // It is not used in the the library's code.
-export type { Config } from "./cli/types";
-
+export type { Config } from "./cli/configSchema";
 export { NON_EDITABLE_FILE_HEADER } from "./cli/constants";

package/src/lib/addBlankLine.ts

@@ -4,7 +4,7 @@ type AddBlankLineConfig = {
 	force?: boolean;
 };
 
-export function addBlankLine(state: string, config?: AddBlankLineConfig) {
+export function addBlankLine(state: string, config?: AddBlankLineConfig): string {
 	if ((!state || state.endsWith("\n\n")) && !config?.force) {
 		return state;
 	} else {

package/src/lib/addLine.ts

@@ -1,5 +1,5 @@
 import { addTrailingNewLine } from "./addTrailingNewLine";
 
-export function addLine(line: string, state: string) {
+export function addLine(line: string, state: string): string {
 	return addTrailingNewLine(state) + line;
 }

package/src/lib/addSection.ts

@@ -1,5 +1,5 @@
 import { addBlankLine } from "./addBlankLine";
 
-export function addSection(section: string, state: string) {
+export function addSection(section: string, state: string): string {
 	return addBlankLine(state) + section;
 }

package/src/lib/addTrailingNewLine.ts

@@ -2,10 +2,7 @@ type AddTrailingNewLineConfig = {
 	force?: boolean;
 };
 
-export function addTrailingNewLine(
-	state: string,
-	config?: AddTrailingNewLineConfig,
-) {
+export function addTrailingNewLine(state: string, config?: AddTrailingNewLineConfig): string {
 	if ((!state || state.endsWith("\n")) && !config?.force) {
 		return state;
 	} else {

package/src/lib/buildCustomTypeDataType.ts

@@ -2,9 +2,7 @@ import type { CustomTypeModel } from "@prismicio/client";
 import { source } from "common-tags";
 
 import { buildTypeName } from "../lib/buildTypeName";
-
-import { AuxiliaryType, FieldConfigs } from "../types";
-
+import type { AuxiliaryType, FieldConfigs } from "../types";
 import { buildFieldProperties } from "./buildFieldProperties";
 import { getHumanReadableModelName } from "./getHumanReadableModelName";
 

package/src/lib/buildCustomTypeType.ts

@@ -1,11 +1,9 @@
 import type { CustomTypeModel } from "@prismicio/client";
 import { source } from "common-tags";
-import QuickLRU from "quick-lru";
-
-import { AuxiliaryType, FieldConfigs } from "../types";
+import type QuickLRU from "quick-lru";
 
 import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants";
-
+import type { AuxiliaryType, FieldConfigs } from "../types";
 import { addSection } from "./addSection";
 import { buildCustomTypeDataType } from "./buildCustomTypeDataType";
 import { buildTypeName } from "./buildTypeName";
@@ -29,7 +27,7 @@ type BuildCustomTypeTypeReturnValue = {
 };
 
 export function buildCustomTypeType(
-	args: BuildCustomTypeTypesArgs,
+	args: BuildCustomTypeTypesArgs
 ): BuildCustomTypeTypeReturnValue {
 	if (args.cache) {
 		const key = getCacheKey(args.model);
@@ -84,7 +82,7 @@ export function buildCustomTypeType(
 			dataType.name
 		}>, "${args.model.id}", Lang>;
 		`,
-		code,
+		code
 	);
 
 	const result = {

package/src/lib/buildFieldDocs.ts

@@ -1,9 +1,7 @@
 import type { CustomTypeModelField } from "@prismicio/client";
 
-import { FieldPath } from "../types";
-
 import { FIELD_DOCUMENTATION_URLS } from "../constants";
-
+import type { FieldPath } from "../types";
 import { addLine } from "./addLine";
 import { getAPIIDPath } from "./getAPIIDPath";
 import { getHumanReadableModelName } from "./getHumanReadableModelName";
@@ -13,9 +11,7 @@ type GetFieldHumanReadableTypeArgs = {
 	field: CustomTypeModelField;
 };
 
-function getHumanReadableFieldType(
-	args: GetFieldHumanReadableTypeArgs,
-): string {
+function getHumanReadableFieldType(args: GetFieldHumanReadableTypeArgs): string {
 	switch (args.field.type) {
 		case "StructuredText": {
 			return "Rich Text";
@@ -24,9 +20,7 @@ function getHumanReadableFieldType(
 		case "IntegrationFields": {
 			const catalog = args.field.config?.catalog;
 
-			return `Integration Fields (Catalog: ${
-				catalog ? `\`${catalog}\`` : "*unknown*"
-			})`;
+			return `Integration Fields (Catalog: ${catalog ? `\`${catalog}\`` : "*unknown*"})`;
 		}
 
 		case "Link": {
@@ -81,9 +75,7 @@ function getDocumentationURL(args: getDocumentationURLArgs) {
 
 		default: {
 			const url =
-				FIELD_DOCUMENTATION_URLS[
-					args.field.type as keyof typeof FIELD_DOCUMENTATION_URLS
-				];
+				FIELD_DOCUMENTATION_URLS[args.field.type as keyof typeof FIELD_DOCUMENTATION_URLS];
 
 			if (typeof url === "string") {
 				return url;
@@ -111,19 +103,14 @@ export function buildFieldDocs(args: BuildFieldDocsArgs): string {
 		field: args.field,
 	});
 
-	result = addLine(
-		` * ${humanReadableName} field in *${humanReadablePath}*`,
-		result,
-	);
+	result = addLine(` * ${humanReadableName} field in *${humanReadablePath}*`, result);
 
 	result = addLine(" *", result);
 
 	result = addLine(` * - **Field Type**: ${humanReadableFieldType}`, result);
 
 	const placeholder =
-		(args.field.config &&
-			"placeholder" in args.field.config &&
-			args.field.config.placeholder) ||
+		(args.field.config && "placeholder" in args.field.config && args.field.config.placeholder) ||
 		`*None*`;
 	result = addLine(` * - **Placeholder**: ${placeholder}`, result);
 
@@ -135,10 +122,7 @@ export function buildFieldDocs(args: BuildFieldDocsArgs): string {
 		const stringifiedDefaultValue =
 			typeof defaultValue === "boolean" ? `${defaultValue}` : defaultValue;
 
-		result = addLine(
-			` * - **Default Value**: ${stringifiedDefaultValue}`,
-			result,
-		);
+		result = addLine(` * - **Default Value**: ${stringifiedDefaultValue}`, result);
 	}
 
 	const apiIDPath = getAPIIDPath({

package/src/lib/buildFieldProperties.ts

@@ -1,11 +1,7 @@
-import {
-	type CustomTypeModelField,
-	CustomTypeModelFieldType,
-} from "@prismicio/client";
+import { type CustomTypeModelField, CustomTypeModelFieldType } from "@prismicio/client";
 import { source, stripIndent } from "common-tags";
 
-import { AuxiliaryType, FieldConfigs, FieldPath } from "../types";
-
+import type { AuxiliaryType, FieldConfigs, FieldPath } from "../types";
 import { addLine } from "./addLine";
 import { addSection } from "./addSection";
 import { buildFieldDocs } from "./buildFieldDocs";
@@ -27,9 +23,7 @@ type BuildFieldPropertyReturnType = {
 	contentTypeNames: string[];
 };
 
-function buildFieldProperty(
-	args: BuildFieldPropertyArgs,
-): BuildFieldPropertyReturnType {
+function buildFieldProperty(args: BuildFieldPropertyArgs): BuildFieldPropertyReturnType {
 	let code = buildFieldDocs({
 		name: args.name,
 		field: args.field,
@@ -41,9 +35,7 @@ function buildFieldProperty(
 	const contentTypeNames: string[] = [];
 
 	const name =
-		args.name.includes("-") ||
-		args.name.includes(":") ||
-		/^[0-9]/.test(args.name)
+		args.name.includes("-") || args.name.includes(":") || /^[0-9]/.test(args.name)
 			? `"${args.name}"`
 			: args.name;
 
@@ -76,12 +68,9 @@ function buildFieldProperty(
 
 			if (args.fieldConfigs.embed?.providerTypes) {
 				for (const providerType in args.fieldConfigs.embed?.providerTypes) {
-					const configuredProviderType =
-						args.fieldConfigs.embed?.providerTypes[providerType];
+					const configuredProviderType = args.fieldConfigs.embed?.providerTypes[providerType];
 
-					providerTypes.push(
-						`({ provider_name: "${providerType}" } & ${configuredProviderType})`,
-					);
+					providerTypes.push(`({ provider_name: "${providerType}" } & ${configuredProviderType})`);
 				}
 			}
 
@@ -92,7 +81,7 @@ function buildFieldProperty(
 					? addLine(
 							`${name}: prismic.EmbedField<prismic.AnyOEmbed & prismic.OEmbedExtra & (${providerTypesUnion})>`,
 							code,
-					  )
+						)
 					: addLine(`${name}: prismic.EmbedField`, code);
 
 			break;
@@ -105,10 +94,7 @@ function buildFieldProperty(
 		}
 
 		case "Image": {
-			if (
-				args.field.config?.thumbnails &&
-				args.field.config.thumbnails.length > 0
-			) {
+			if (args.field.config?.thumbnails && args.field.config.thumbnails.length > 0) {
 				const thumbnailNames = buildUnion(
 					args.field.config.thumbnails.map((thumb) => `"${thumb.name}"`),
 				);
@@ -123,16 +109,11 @@ function buildFieldProperty(
 
 		case "IntegrationFields": {
 			const catalogType = args.field.config?.catalog
-				? args.fieldConfigs.integrationFields?.catalogTypes?.[
-						args.field.config.catalog
-				  ]
+				? args.fieldConfigs.integrationFields?.catalogTypes?.[args.field.config.catalog]
 				: undefined;
 
 			if (catalogType) {
-				code = addLine(
-					`${name}: prismic.IntegrationField<${catalogType}>;`,
-					code,
-				);
+				code = addLine(`${name}: prismic.IntegrationField<${catalogType}>;`, code);
 			} else {
 				code = addLine(`${name}: prismic.IntegrationField;`, code);
 			}
@@ -147,7 +128,7 @@ function buildFieldProperty(
 				Array.isArray(args.field.config.variants) &&
 				args.field.config.variants.length > 0
 					? args.field.config.variants
-							.map((variant) => `"${variant.replace(/\"/g, '\\"')}"`)
+							.map((variant) => `"${variant.replace(/"/g, '\\"')}"`)
 							.join(" | ")
 					: "never";
 
@@ -164,9 +145,7 @@ function buildFieldProperty(
 									return `prismic.ContentRelationshipField<"${type}">`;
 								}
 
-								return `ContentRelationshipFieldWithData<${JSON.stringify([
-									type,
-								])}>`;
+								return `ContentRelationshipFieldWithData<${JSON.stringify([type])}>`;
 							}),
 						);
 
@@ -214,22 +193,16 @@ function buildFieldProperty(
 		}
 
 		case "Select": {
-			const options: string[] =
-				args.field.config?.options?.map((option) => `"${option}"`) || [];
+			const options: string[] = args.field.config?.options?.map((option) => `"${option}"`) || [];
 			const optionsType = options.length ? buildUnion(options) : "string";
 
 			const hasDefault = Boolean(args.field.config?.default_value);
 
 			if (hasDefault) {
-				code = addLine(
-					`${name}: prismic.SelectField<${optionsType}, "filled">;`,
-					code,
-				);
+				code = addLine(`${name}: prismic.SelectField<${optionsType}, "filled">;`, code);
 			} else {
 				code = addLine(
-					`${name}: prismic.SelectField${
-						options.length > 0 ? `<${optionsType}>` : ""
-					};`,
+					`${name}: prismic.SelectField${options.length > 0 ? `<${optionsType}>` : ""};`,
 					code,
 				);
 			}
@@ -323,15 +296,9 @@ function buildFieldProperty(
 			contentTypeNames.push(itemName);
 
 			if (isNestedGroup) {
-				code = addLine(
-					`${name}: prismic.NestedGroupField<Simplify<${itemName}>>;`,
-					code,
-				);
+				code = addLine(`${name}: prismic.NestedGroupField<Simplify<${itemName}>>;`, code);
 			} else {
-				code = addLine(
-					`${name}: prismic.GroupField<Simplify<${itemName}>>;`,
-					code,
-				);
+				code = addLine(`${name}: prismic.GroupField<Simplify<${itemName}>>;`, code);
 			}
 
 			break;
@@ -367,10 +334,7 @@ function buildFieldProperty(
 						);
 
 						let primaryInterfaceName: string | undefined;
-						if (
-							choice["non-repeat"] &&
-							Object.keys(choice["non-repeat"]).length > 0
-						) {
+						if (choice["non-repeat"] && Object.keys(choice["non-repeat"]).length > 0) {
 							primaryInterfaceName = buildTypeName(sliceName, "Primary");
 
 							const path: FieldPath = [
@@ -411,11 +375,8 @@ function buildFieldProperty(
 											}
 										`,
 										primaryCode,
-								  )
-								: addLine(
-										`export interface ${primaryInterfaceName} {}`,
-										primaryCode,
-								  );
+									)
+								: addLine(`export interface ${primaryInterfaceName} {}`, primaryCode);
 
 							auxiliaryTypes.push({
 								name: primaryInterfaceName,
@@ -466,7 +427,7 @@ function buildFieldProperty(
 											}
 										`,
 										itemCode,
-								  )
+									)
 								: addLine(`export interface ${itemInterfaceName} {}`, itemCode);
 
 							auxiliaryTypes.push({
@@ -491,12 +452,10 @@ function buildFieldProperty(
 									})}*
 								 */
 								export type ${sliceName} = prismic.Slice<"${choiceID}", ${
-								primaryInterfaceName
-									? `Simplify<${primaryInterfaceName}>`
-									: `Record<string, never>`
-							}, ${
-								itemInterfaceName ? `Simplify<${itemInterfaceName}>` : `never`
-							}>
+									primaryInterfaceName
+										? `Simplify<${primaryInterfaceName}>`
+										: `Record<string, never>`
+								}, ${itemInterfaceName ? `Simplify<${itemInterfaceName}>` : `never`}>
 							`,
 						});