fix: Remove more "required optionals" from OpenAPI spec (#1522)

Co-authored-by: Hampus <[email protected]>

fluxer_api/src/api/openapi/openapi.json

@@ -31590,8 +31590,7 @@
 						"anyOf": [{"type": "string"}, {"type": "null"}],
 						"description": "The voice connection ID for the member"
 					}
-				},
-				"required": ["nick", "communication_disabled_until"]
+				}
 			},
 			"GuildRoleCreateRequest": {
 				"type": "object",

packages/openapi/src/converters/ZodInternals.ts

@@ -73,6 +73,7 @@ interface ZodInternalDefinition {
 	kind?: string;
 	getter?: () => ZodTypeAny;
 	pattern?: RegExp;
+	transform?: (input: unknown) => unknown;
 }
 
 interface ZodInternalSchema {

packages/openapi/src/converters/ZodToOpenAPI.ts

@@ -58,22 +58,32 @@ function getSchemaName(schema: ZodTypeAny): string | undefined {
 function isSchemaOptional(schema: ZodTypeAny, depth = 0): boolean {
 	if (depth > 10) return false;
 	const typeName = getZodTypeName(schema);
-	if (typeName === 'ZodOptional' || typeName === 'optional') {
+
+	if (typeName === 'ZodOptional' || typeName === 'optional' || typeName === 'ZodDefault' || typeName === 'default') {
 		return true;
 	}
-	if (typeName === 'ZodDefault' || typeName === 'default') {
-		return true;
-	}
-	if (typeName === 'ZodNullable' || typeName === 'nullable') {
+	if (typeName === 'ZodNullable' || typeName === 'nullable' || typeName === 'ZodEffects' || typeName === 'effect') {
 		const inner = getInnerType(schema);
 		if (inner) {
 			return isSchemaOptional(inner, depth + 1);
 		}
 	}
-	if (typeName === 'ZodEffects' || typeName === 'effect' || typeName === 'ZodPipeline' || typeName === 'pipe') {
-		const inner = getInnerType(schema);
+	if (typeName === 'ZodPipeline' || typeName === 'pipe') {
+		const schemaDef = getZodDefinition(schema);
+		const {out: outer, in: inner} = schemaDef;
 		if (inner) {
-			return isSchemaOptional(inner, depth + 1);
+			const innerTypeName = getZodTypeName(inner);
+			if (innerTypeName === 'ZodTransform' || innerTypeName === 'transform') {
+				const {transform: transformFunc} = getZodDefinition(inner);
+
+				// if the transformed schema ("outer") is optional OR the transform function explicitly handles the `undefined` input
+				return (
+					(outer !== undefined && isSchemaOptional(outer, depth + 1)) ||
+					(transformFunc !== undefined && transformFunc(undefined) !== undefined)
+				);
+			} else {
+				return isSchemaOptional(inner, depth + 1);
+			}
 		}
 	}
 	return false;
@@ -461,8 +471,7 @@ export function zodToOpenAPISchema(schema: ZodTypeAny, depth = 0): OpenAPISchema
 				return {type: 'object'};
 			}
 			const objectAnnotation = parseFluxerTypeAnnotation(getDescription(schema));
-			const namedObjectName =
-				objectAnnotation?.typeName === 'NamedObject' ? objectAnnotation.objectName : undefined;
+			const namedObjectName = objectAnnotation?.typeName === 'NamedObject' ? objectAnnotation.objectName : undefined;
 			if (namedObjectName && depth > 0 && namedObjectRegistry.has(namedObjectName)) {
 				return makeNamedObjectRef(namedObjectName, objectAnnotation?.fieldDescription);
 			}

packages/schema/src/domains/message/MessageRequestSchemas.ts

@@ -101,7 +101,6 @@ export const RichEmbedRequest = z.object({
 	timestamp: DateTimeType.nullish().describe('ISO8601 timestamp for the embed'),
 	description: z
 		.preprocess(omitEmptyString, createStringType(1, RICH_EMBED_DESCRIPTION_MAX_LENGTH).nullish())
-		.optional()
 		.describe(`Description of the embed (1-${RICH_EMBED_DESCRIPTION_MAX_LENGTH} characters)`),
 	author: RichEmbedAuthorRequest.nullish().describe('Author information'),
 	image: RichEmbedMediaRequest.nullish().describe('Image to display in the embed'),