prismic-ts-codegen 0.1.11 → 0.1.13

package/src/lib/addTypeAliasForCustomType.ts

@@ -1,120 +0,0 @@
-import type { CustomTypeModel, CustomTypeModelField } from "@prismicio/client";
-import type {
-	InterfaceDeclaration,
-	SourceFile,
-	TypeAliasDeclaration,
-} from "ts-morph";
-
-import { FieldConfigs } from "../types";
-
-import { CUSTOM_TYPES_DOCUMENTATION_URL } from "../constants";
-
-import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
-import { buildTypeName } from "./buildTypeName";
-
-const collectCustomTypeFields = (
-	model: CustomTypeModel,
-): Record<string, CustomTypeModelField> => {
-	return Object.assign({}, ...Object.values(model.json));
-};
-
-type AddTypeAliasForCustomTypeConfig = {
-	model: CustomTypeModel;
-	sourceFile: SourceFile;
-	localeIDs: string[];
-	fieldConfigs: FieldConfigs;
-};
-
-export const addTypeAliasForCustomType = ({
-	model,
-	sourceFile,
-	localeIDs,
-	fieldConfigs,
-}: AddTypeAliasForCustomTypeConfig): TypeAliasDeclaration => {
-	const { uid: uidField, ...fields } = collectCustomTypeFields(model);
-	const hasDataFields = Object.keys(fields).length > 0;
-	const hasUIDField = Boolean(uidField);
-
-	let dataInterface: InterfaceDeclaration | TypeAliasDeclaration;
-	if (hasDataFields) {
-		dataInterface = sourceFile.addInterface({
-			name: buildTypeName(model.id, "Document", "Data"),
-			docs: [
-				{
-					description: `Content for ${model.label} documents`,
-				},
-			],
-		});
-
-		for (const tabName in model.json) {
-			// This is destructured to ensure the UID field is
-			// ignored.
-			const { uid: _uidField, ...tabFields } = model.json[tabName];
-
-			addInterfacePropertiesForFields({
-				fields: tabFields,
-				interface: dataInterface,
-				sourceFile: sourceFile,
-				path: [
-					{
-						id: model.id,
-						model: model,
-					},
-				],
-				fieldConfigs,
-				tabName,
-			});
-		}
-	} else {
-		dataInterface = sourceFile.addTypeAlias({
-			name: buildTypeName(model.id, "Document", "Data"),
-			type: `Record<string, never>`,
-			docs: [
-				{
-					description: `Content for ${model.label} documents`,
-				},
-			],
-		});
-	}
-
-	return sourceFile.addTypeAlias({
-		name: buildTypeName(model.id, "Document"),
-		typeParameters: [
-			{
-				name: "Lang",
-				constraint: "string",
-				default:
-					localeIDs.length > 0
-						? localeIDs.map((localeID) => `"${localeID}"`).join(" | ")
-						: "string",
-			},
-		],
-		type: hasUIDField
-			? `prismic.PrismicDocumentWithUID<Simplify<${dataInterface.getName()}>, "${
-					model.id
-			  }", Lang>`
-			: `prismic.PrismicDocumentWithoutUID<Simplify<${dataInterface.getName()}>, "${
-					model.id
-			  }", Lang>`,
-		docs: [
-			{
-				description: (writer) => {
-					writer.writeLine(`${model.label} document from Prismic`);
-					writer.blankLine();
-					writer.writeLine(`- **API ID**: \`${model.id}\``);
-					writer.writeLine(`- **Repeatable**: \`${model.repeatable}\``);
-					writer.writeLine(
-						`- **Documentation**: ${CUSTOM_TYPES_DOCUMENTATION_URL}`,
-					);
-				},
-				tags: [
-					{
-						tagName: "typeParam",
-						text: "Lang - Language API ID of the document.",
-					},
-				],
-			},
-		],
-		isExported: true,
-	});
-};

package/src/lib/addTypeAliasForSharedSlice.ts

@@ -1,201 +0,0 @@
-import type { SharedSliceModel } from "@prismicio/client";
-import type {
-	InterfaceDeclaration,
-	SourceFile,
-	TypeAliasDeclaration,
-} from "ts-morph";
-
-import { FieldConfigs } from "../types";
-
-import { SHARED_SLICES_DOCUMENTATION_URL } from "../constants";
-
-import { addInterfacePropertiesForFields } from "./addInterfacePropertiesForFields";
-import { buildSharedSliceInterfaceNamePart } from "./buildSharedSliceInterfaceNamePart";
-import { buildTypeName } from "./buildTypeName";
-import { getHumanReadableFieldPath } from "./getHumanReadableFieldPath";
-
-type AddTypeAliasForSharedSliceConfig = {
-	model: SharedSliceModel;
-	sourceFile: SourceFile;
-	fieldConfigs: FieldConfigs;
-};
-
-export const addTypeAliasForSharedSlice = (
-	config: AddTypeAliasForSharedSliceConfig,
-): TypeAliasDeclaration => {
-	const variationTypeNames: string[] = [];
-
-	for (const variation of config.model.variations) {
-		let primaryInterface: InterfaceDeclaration | undefined;
-		if (variation.primary && Object.keys(variation.primary).length > 0) {
-			primaryInterface = config.sourceFile.addInterface({
-				name: buildTypeName(
-					buildSharedSliceInterfaceNamePart({ id: config.model.id }),
-					variation.id,
-					"Primary",
-				),
-				docs: [
-					{
-						description: (writer) => {
-							const humanReadablePath = getHumanReadableFieldPath({
-								path: [
-									{
-										id: config.model.id,
-										model: config.model,
-									},
-									{
-										id: "primary",
-										label: "Primary",
-									},
-								],
-							});
-
-							writer.writeLine(`Primary content in ${humanReadablePath}`);
-						},
-					},
-				],
-			});
-			addInterfacePropertiesForFields({
-				interface: primaryInterface,
-				sourceFile: config.sourceFile,
-				fields: variation.primary,
-				path: [
-					{
-						id: config.model.id,
-						model: config.model,
-					},
-					{
-						id: "primary",
-						label: "Primary",
-					},
-				],
-				fieldConfigs: config.fieldConfigs,
-			});
-		}
-
-		let itemInterface: InterfaceDeclaration | undefined;
-		if (variation.items && Object.keys(variation.items).length > 0) {
-			itemInterface = config.sourceFile.addInterface({
-				name: buildTypeName(
-					buildSharedSliceInterfaceNamePart({ id: config.model.id }),
-					variation.id,
-					"Item",
-				),
-				docs: [
-					{
-						description: (writer) => {
-							const humanReadablePath = getHumanReadableFieldPath({
-								path: [
-									{
-										id: config.model.id,
-										model: config.model,
-									},
-									{
-										id: "items",
-										label: "Items",
-									},
-								],
-							});
-
-							writer.writeLine(`Item in ${humanReadablePath}`);
-						},
-					},
-				],
-				isExported: true,
-			});
-			addInterfacePropertiesForFields({
-				interface: itemInterface,
-				sourceFile: config.sourceFile,
-				fields: variation.items,
-				path: [
-					{
-						id: config.model.id,
-						model: config.model,
-					},
-					{
-						id: "items",
-						label: "Items",
-					},
-				],
-				fieldConfigs: config.fieldConfigs,
-			});
-		}
-
-		const variationType = config.sourceFile.addTypeAlias({
-			name: buildTypeName(
-				buildSharedSliceInterfaceNamePart({ id: config.model.id }),
-				variation.id,
-			),
-			type: `prismic.SharedSliceVariation<"${variation.id}", ${
-				primaryInterface
-					? `Simplify<${primaryInterface.getName()}>`
-					: "Record<string, never>"
-			}, ${itemInterface ? `Simplify<${itemInterface.getName()}>` : "never"}>`,
-			docs: [
-				{
-					description: (writer) => {
-						writer.writeLine(
-							`${variation.name} variation for ${config.model.name} Slice`,
-						);
-						writer.blankLine();
-						writer.writeLine(`- **API ID**: \`${variation.id}\``);
-						writer.writeLine(`- **Description**: \`${variation.description}\``);
-						writer.writeLine(
-							`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`,
-						);
-					},
-				},
-			],
-			isExported: true,
-		});
-
-		variationTypeNames.push(variationType.getName());
-	}
-
-	const variationsType = config.sourceFile.addTypeAlias({
-		name: buildTypeName(config.model.id, "Slice", "Variation"),
-		type:
-			variationTypeNames.length > 0 ? variationTypeNames.join(" | ") : "never",
-		docs: [
-			{
-				description: (writer) => {
-					const humanReadablePath = getHumanReadableFieldPath({
-						path: [
-							{
-								id: config.model.id,
-								model: config.model,
-							},
-						],
-					});
-
-					writer.writeLine(`Slice variation for *${humanReadablePath}*`);
-				},
-			},
-		],
-	});
-
-	return config.sourceFile.addTypeAlias({
-		name: buildTypeName(
-			buildSharedSliceInterfaceNamePart({ id: config.model.id }),
-		),
-		type: `prismic.SharedSlice<"${
-			config.model.id
-		}", ${variationsType.getName()}>`,
-		docs: [
-			{
-				description: (writer) => {
-					writer.writeLine(`${config.model.name} Shared Slice`);
-					writer.blankLine();
-					writer.writeLine(`- **API ID**: \`${config.model.id}\``);
-					writer.writeLine(
-						`- **Description**: \`${config.model.description}\``,
-					);
-					writer.writeLine(
-						`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`,
-					);
-				},
-			},
-		],
-		isExported: true,
-	});
-};

package/src/lib/buildSharedSliceInterfaceNamePart.ts

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

package/src/lib/getFieldDocumentationURL.ts

@@ -1,15 +0,0 @@
-import type { CustomTypeModelField } from "@prismicio/client";
-
-import { FIELD_DOCUMENTATION_URLS } from "../constants";
-
-type GetFieldDocumentationURLConfig = {
-	model: CustomTypeModelField;
-};
-
-export const getFieldDocumentationURL = (
-	config: GetFieldDocumentationURLConfig,
-): string | undefined => {
-	return FIELD_DOCUMENTATION_URLS[
-		config.model.type as keyof typeof FIELD_DOCUMENTATION_URLS
-	];
-};

package/src/lib/getHumanReadableFieldPath.ts

@@ -1,36 +0,0 @@
-import type {
-	CustomTypeModel,
-	CustomTypeModelField,
-	CustomTypeModelSlice,
-	SharedSliceModel,
-} from "@prismicio/client";
-
-import { PathElement } from "../types";
-
-import { getHumanReadableModelName } from "./getHumanReadableModelName";
-
-type GetHumanReadableFieldPathConfig = {
-	path: [
-		PathElement<CustomTypeModel | SharedSliceModel>,
-		...PathElement<CustomTypeModelField | CustomTypeModelSlice>[],
-	];
-};
-
-export const getHumanReadableFieldPath = (
-	config: GetHumanReadableFieldPathConfig,
-): string => {
-	return config.path
-		.map((element) => {
-			if (element.label) {
-				return element.label;
-			} else if (element.model) {
-				return getHumanReadableModelName({
-					id: element.id,
-					model: element.model,
-				});
-			} else {
-				return element.id;
-			}
-		})
-		.join(" → ");
-};

package/src/lib/getHumanReadableFieldType.ts

@@ -1,55 +0,0 @@
-import type { CustomTypeModelField } from "@prismicio/client";
-
-type GetFieldHumanReadableTypeConfig = {
-	model: CustomTypeModelField;
-};
-
-export const getHumanReadableFieldType = (
-	config: GetFieldHumanReadableTypeConfig,
-): string => {
-	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));
-
-			return isTitleField ? "Title" : "Rich Text";
-		}
-
-		case "IntegrationFields": {
-			const catalog = config.model.config?.catalog;
-
-			return `Integration Fields (Catalog: ${
-				catalog ? `\`${catalog}\`` : "*unknown*"
-			})`;
-		}
-
-		case "Link": {
-			switch (config.model.config?.select) {
-				case "document": {
-					return "Content Relationship";
-				}
-
-				case "media": {
-					return "Link to Media";
-				}
-
-				default: {
-					return "Link";
-				}
-			}
-		}
-
-		case "Slices": {
-			return "Slice Zone";
-		}
-
-		default: {
-			return config.model.type;
-		}
-	}
-};

package/src/lib/getSourceFileText.ts

@@ -1,14 +0,0 @@
-import * as tsm from "ts-morph";
-
-// import prettier from "prettier";
-import { BLANK_LINE_IDENTIFIER } from "../constants";
-
-export const getSourceFileText = (sourceFile: tsm.SourceFile): string => {
-	const text = sourceFile
-		.print()
-		.replace(new RegExp(BLANK_LINE_IDENTIFIER, "g"), "");
-
-	return text;
-
-	// return prettier.format(text, { parser: "typescript" });
-};

package/src/lib/hasOwnProperty.ts

@@ -1,15 +0,0 @@
-/**
- * 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/isCustomTypeModel.ts

@@ -1,5 +0,0 @@
-import type { CustomTypeModel } from "@prismicio/client";
-
-export const isCustomTypeModel = (model: unknown): model is CustomTypeModel => {
-	return typeof model === "object" && model !== null && "json" in model;
-};

package/src/lib/isCustomTypeModelField.ts

@@ -1,7 +0,0 @@
-import type { CustomTypeModelField } from "@prismicio/client";
-
-export const isCustomTypeModelField = (
-	model: unknown,
-): model is CustomTypeModelField => {
-	return typeof model === "object" && model !== null && "type" in model;
-};

package/src/lib/isCustomTypeModelSlice.ts

@@ -1,14 +0,0 @@
-import type { CustomTypeModelSlice } from "@prismicio/client";
-
-import { hasOwnProperty } from "./hasOwnProperty";
-
-export const isCustomTypeModelSlice = (
-	model: unknown,
-): model is CustomTypeModelSlice => {
-	return (
-		typeof model === "object" &&
-		model !== null &&
-		hasOwnProperty(model, "type") &&
-		model.type === "Slice"
-	);
-};

package/src/lib/isSharedSliceModel.ts

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

package/src/lib/pascalCase.ts

@@ -1,9 +0,0 @@
-import {
-	pascalCase as pascalCaseBase,
-	pascalCaseTransformMerge,
-} from "pascal-case";
-
-export const pascalCase = (input: string): string =>
-	pascalCaseBase(input, {
-		transform: pascalCaseTransformMerge,
-	});

package/src/lib/writeFieldDocsDescription.ts

@@ -1,51 +0,0 @@
-import type { CodeBlockWriter } from "ts-morph";
-
-type BuildFieldDocsConfig = {
-	writer: CodeBlockWriter;
-	description?: string;
-	fieldType?: string;
-	defaultValue?: string | boolean;
-	placeholder?: string;
-	apiIDPath?: string;
-	tabName?: string;
-	documentationURL?: string;
-};
-
-export const writeFieldDocsDescription = (
-	config: BuildFieldDocsConfig,
-): void => {
-	if (config.description) {
-		config.writer.writeLine(config.description);
-	}
-
-	config.writer.blankLineIfLastNot();
-
-	if (config.fieldType) {
-		config.writer.writeLine(`- **Field Type**: ${config.fieldType}`);
-	}
-
-	if (config.placeholder) {
-		config.writer.writeLine(`- **Placeholder**: ${config.placeholder}`);
-	}
-
-	if (config.defaultValue !== undefined) {
-		const stringifiedDefaultValue =
-			typeof config.defaultValue === "boolean"
-				? `${config.defaultValue}`
-				: config.defaultValue;
-
-		config.writer.writeLine(`- **Default Value**: ${stringifiedDefaultValue}`);
-	}
-
-	if (config.apiIDPath) {
-		config.writer.writeLine(`- **API ID Path**: ${config.apiIDPath}`);
-	}
-
-	if (config.tabName) {
-		config.writer.writeLine(`- **Tab**: ${config.tabName}`);
-	}
-
-	if (config.documentationURL) {
-		config.writer.writeLine(`- **Documentation**: ${config.documentationURL}`);
-	}
-};