@kontent-ai/model-generator/lib/generators/delivery/delivery-func.ts

This utility generates strongly-typed models for Delivery JS SDK, Migration toolkit or just general scripting to improve the experience when referencing Kontent.ai related objects.

import type { EnvironmentModels } from "@kontent-ai/management-sdk";
import chalk from "chalk";
import type { CliAction, CreateFilesConfig, GeneratedFile, GeneratedSet, ModuleFileExtension } from "../../core/core.models.js";
import { getManagementKontentFetcher } from "../../fetch/management-kontent-fetcher.js";
import { getFileManager } from "../../files/file-manager.js";
import type { FormatOptions } from "../../format/formatter.js";
import { type DeliveryFileResolvers, type DeliveryNameResolvers, deliveryGenerator } from "./delivery.generator.js";

export type GenerateDeliveryModelsConfig = {
	readonly environmentId: string;
	readonly addTimestamp: boolean;
	readonly managementApiKey: string;
	readonly moduleFileExtension: ModuleFileExtension;

	readonly managementBaseUrl?: string;
	readonly formatOptions?: FormatOptions;

	readonly fileResolvers?: DeliveryFileResolvers;
	readonly nameResolvers?: DeliveryNameResolvers;
	readonly disableComments?: boolean;
} & CreateFilesConfig;

export async function generateDeliveryModelsAsync(config: GenerateDeliveryModelsConfig): Promise<readonly GeneratedFile[]> {
	console.log(chalk.green("Model generator started \n"));
	console.log(`Generating '${chalk.yellow("delivery-sdk" satisfies CliAction)}' models\n`);

	const { environmentInfo, files } = await getFilesAsync(config);

	const fileManager = getFileManager({
		disableComments: config.disableComments ?? false,
		...config,
		environmentInfo,
	});

	const setFiles = await fileManager.getSetFilesAsync(files);

	if (config.createFiles) {
		fileManager.createFiles(setFiles);
	}

	console.log(chalk.green("\nCompleted"));

	return setFiles;
}

async function getFilesAsync(config: GenerateDeliveryModelsConfig): Promise<{
	readonly files: readonly GeneratedSet[];
	readonly environmentInfo: Readonly<EnvironmentModels.EnvironmentInformationModel>;
}> {
	const kontentFetcher = getManagementKontentFetcher({
		environmentId: config.environmentId,
		managementApiKey: config.managementApiKey,
		baseUrl: config.managementBaseUrl,
	});

	const environmentInfo = await kontentFetcher.getEnvironmentInfoAsync();

	const [taxonomies, types, snippets, languages, collections, workflows] = await Promise.all([
		kontentFetcher.getTaxonomiesAsync(),
		kontentFetcher.getTypesAsync(),
		kontentFetcher.getSnippetsAsync(),
		kontentFetcher.getLanguagesAsync(),
		kontentFetcher.getCollectionsAsync(),
		kontentFetcher.getWorkflowsAsync(),
	]);

	const generator = deliveryGenerator({
		moduleFileExtension: config.moduleFileExtension,
		disableComments: config.disableComments ?? false,
		environmentData: {
			environment: environmentInfo,
			types,
			snippets,
			taxonomies,
			languages,
			collections,
			workflows,
		},
		fileResolvers: config.fileResolvers,
		nameResolvers: config.nameResolvers,
	});

	return {
		files: [...generator.getTypeFiles(), generator.getSystemFiles()],
		environmentInfo,
	};
}