Add schema scope to generator template's naming callbacks

karlvr · Aug 16, 2024 · 207ebd5 · 207ebd5
1 parent 7ff4cb7
commit 207ebd5
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 0 deletions.
diff --git a/.changeset/olive-swans-peel.md b/.changeset/olive-swans-peel.md
@@ -0,0 +1,6 @@
+---
+"@openapi-generator-plus/types": minor
+"@openapi-generator-plus/core": minor
+---
+
+Add schema scope to generator template's naming callbacks
diff --git a/packages/core/src/process/schema/index.ts b/packages/core/src/process/schema/index.ts
@@ -139,6 +139,7 @@ function toCodegenSchema(apiSchema: OpenAPIX.SchemaObject, $ref: string | undefi
 	suggestedName = state.generator.toSuggestedSchemaName(suggestedName, {
 		purpose,
 		schemaType,
+		scope: suggestedScope,
 	})
 
 	const naming = supportedNamedSchema(schemaType, !!$ref, purpose, state) ? toUniqueScopedName($ref, suggestedName, suggestedScope, apiSchema, schemaType, purpose, state) : null

diff --git a/packages/core/src/process/schema/interface.ts b/packages/core/src/process/schema/interface.ts
@@ -34,6 +34,7 @@ export function createIfNotExistsCodegenInterfaceSchema(schema: CodegenObjectSch
 	const suggestedName = state.generator.toSuggestedSchemaName(baseSuggestedNameForRelatedSchemas(schema), {
 		purpose,
 		schemaType: CodegenSchemaType.INTERFACE,
+		scope,
 	})
 	const naming = toUniqueScopedName(undefined, suggestedName, scope, undefined, CodegenSchemaType.INTERFACE, purpose, state)
 	usedSchemaName(naming.scopedName, state)

diff --git a/packages/core/src/process/schema/naming.ts b/packages/core/src/process/schema/naming.ts
@@ -38,6 +38,7 @@ function toScopedName($ref: string | undefined, suggestedName: string, scope: Co
 
 	const nameOptions: CodegenSchemaNameOptions = {
 		schemaType,
+		scope,
 	}
 	let name = state.generator.toSchemaName(suggestedName, nameOptions)
 

diff --git a/packages/core/src/process/schema/object.ts b/packages/core/src/process/schema/object.ts
@@ -197,6 +197,7 @@ export function createObjectSchema(suggestedName: string, scope: CodegenScope |
 	suggestedName = state.generator.toSuggestedSchemaName(suggestedName, {
 		purpose,
 		schemaType: CodegenSchemaType.OBJECT,
+		scope,
 	})
 
 	const naming = toUniqueScopedName(undefined, suggestedName, scope, undefined, CodegenSchemaType.OBJECT, purpose, state)

diff --git a/packages/core/src/process/schema/one-of.ts b/packages/core/src/process/schema/one-of.ts
@@ -234,6 +234,7 @@ export function createOneOfSchema(suggestedName: string, scope: CodegenScope | n
 	suggestedName = state.generator.toSuggestedSchemaName(suggestedName, {
 		purpose,
 		schemaType: CodegenSchemaType.OBJECT,
+		scope,
 	})
 
 	const naming = toUniqueScopedName(undefined, suggestedName, scope, undefined, CodegenSchemaType.OBJECT, purpose, state)

diff --git a/packages/types/src/types.ts b/packages/types/src/types.ts
@@ -866,11 +866,15 @@ export interface CodegenDiscriminatorMappings {
 
 export interface CodegenSchemaNameOptions {
 	schemaType: CodegenSchemaType
+	/** The scope that the schema to name is scoped inside */
+	scope: CodegenScope | null
 }
 
 export interface CodegenSchemaNameSuggestionOptions {
 	purpose: CodegenSchemaPurpose
 	schemaType: CodegenSchemaType
+	/** The scope that the schema to suggest a name for will probably be scoped inside */
+	scope: CodegenScope | null
 }
 
 export interface CodegenTypeOptions {