Fix redocument for other schemas

Author: CloudCannonGeorge

docs-site/eleventy.config.js

@@ -1,11 +1,11 @@
-import syntaxHighlight from "@11ty/eleventy-plugin-syntaxhighlight";
 import { RenderPlugin } from '@11ty/eleventy';
+import syntaxHighlight from '@11ty/eleventy-plugin-syntaxhighlight';
 import documentation from '../dist/documentation.json' with { type: 'json' };
 
 export default function (eleventyConfig) {
 	eleventyConfig.addPlugin(syntaxHighlight);
 	eleventyConfig.addPlugin(RenderPlugin);
-	eleventyConfig.addGlobalData('docs', Object.values(documentation["type.Configuration"]));
+	eleventyConfig.addGlobalData('docs', Object.values(documentation['type.Configuration']));
 
 	eleventyConfig.addFilter('json', (json) => {
 		if (typeof json === 'object') {

docs/index.ts

@@ -78,10 +78,7 @@ function flattenNestedAnyOf(doc: JsonSchema, schema: JsonSchema): void {
 	}
 }
 
-function getDocumentationEntry(
-	gid: string,
-	ctx: ProcessContext
-): DocumentationEntry | undefined {
+function getDocumentationEntry(gid: string, ctx: ProcessContext): DocumentationEntry | undefined {
 	ctx.attemptedGids.add(gid);
 	return ctx.documentationEntries[gid];
 }
@@ -117,9 +114,9 @@ function docToPage(
 	if (isRootType) {
 		thisPath = [];
 		gid = config.rootTypeId;
-	} else if (isTypeRef) {
-		thisPath = [doc.id!];
-		gid = doc.id!;
+	} else if (isTypeRef && doc.id) {
+		thisPath = [doc.id];
+		gid = doc.id;
 	} else if (key) {
 		thisPath = [...docPath, key];
 		gid = thisPath.join('.');
@@ -157,10 +154,10 @@ function docToPage(
 	if (!thisPath.length) {
 		url = config.urlPrefix;
 	} else {
-		url = `${config.urlPrefix}${thisPath.join('/').replace(/^type\./, 'types/').replaceAll('.', '/')}/`.replace(
-			/\/+/g,
-			'/'
-		);
+		url = `${config.urlPrefix}${thisPath
+			.join('/')
+			.replace(/^type\./, 'types/')
+			.replaceAll('.', '/')}/`.replace(/\/+/g, '/');
 	}
 
 	const page: Page = {

generate-schemas.ts

@@ -196,6 +196,8 @@ const schemas = [
 		convertSchemaAnys: true,
 		addMarkdownDescription: true,
 		stripId: true,
+		redocument: true,
+		docsFolder: 'docs/routing',
 	},
 	{
 		schema: InitialSiteSettingsSchema.meta({
@@ -213,6 +215,8 @@ const schemas = [
 		convertSchemaAnys: true,
 		addMarkdownDescription: true,
 		stripId: true,
+		redocument: true,
+		docsFolder: 'docs/initial-site-settings',
 	},
 ];
 
@@ -258,7 +262,9 @@ for (const schemaConfig of schemas) {
 	await fs.writeFile(fullSchemaPath, JSON.stringify(jsonSchema, null, '  '));
 
 	if (schemaConfig.redocument) {
-		await redocumentSchema(fullSchemaPath, {
+		const docsFolder =
+			'docsFolder' in schemaConfig ? schemaConfig.docsFolder : 'docs/documentation';
+		await redocumentSchema(fullSchemaPath, docsFolder, {
 			stripId: schemaConfig.stripId,
 			addMarkdownDescription: schemaConfig.addMarkdownDescription,
 		});

redocument-schemas.ts

@@ -2,14 +2,13 @@ import fs from 'node:fs/promises';
 import { readDocs } from './docs/docs.js';
 import { type DocumentationEntry, type JsonSchema, slugify } from './docs/util.js';
 
-const documentationEntries: Record<string, DocumentationEntry> = await readDocs(
-	'docs/documentation'
-);
-
 export async function redocumentSchema(
 	fullSchemaPath: string,
+	folder: string,
 	options?: { stripId?: boolean; addMarkdownDescription?: boolean }
 ): Promise<void> {
+	const documentationEntries: Record<string, DocumentationEntry> = await readDocs(folder);
+
 	const schemaRaw: string = await fs.readFile(fullSchemaPath, { encoding: 'utf8' });
 	const schema: JsonSchema = JSON.parse(schemaRaw);
 

src/routing.ts

@@ -12,10 +12,13 @@ const RouteStatusCodes = {
 	Gone: 410,
 } as const;
 
-export const RouteStatusSchema = z.enum(RouteStatusCodes).default(RouteStatusCodes.MovedPermanently).meta({
-	description:
-		'The HTTP status code for this redirect rule. When using 200, 404, and 410 status codes, `to` must refer to a path on the same Site.',
-});
+export const RouteStatusSchema = z
+	.enum(RouteStatusCodes)
+	.default(RouteStatusCodes.MovedPermanently)
+	.meta({
+		description:
+			'The HTTP status code for this redirect rule. When using 200, 404, and 410 status codes, `to` must refer to a path on the same Site.',
+	});
 
 export const RouteSchema = z
 	.object({

tests/initial-site-settings.test.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 import { test } from 'node:test';
 import {
-	InitialSiteSettingsSchema,
 	BuildConfigSchema,
+	InitialSiteSettingsSchema,
 	SiteModeSchema,
 } from '../src/initial-site-settings.ts';
 

tests/routing.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { test } from 'node:test';
-import { RoutingSchema, RouteSchema, HeaderRuleSchema } from '../src/routing.ts';
+import { HeaderRuleSchema, RouteSchema, RoutingSchema } from '../src/routing.ts';
 
 test('should accept an empty routing configuration', () => {
 	const routing = {};