Fix entity names to use PascalCase instead of underscores

Copilot · abraham · Copilot · commit ee89233f2b59 · 2025-09-20T22:11:23.000Z
Co-authored-by: abraham &lt;3341+abraham@users.noreply.github.com&gt;
diff --git a/dist/schema.json b/dist/schema.json
diff --git a/src/__tests__/generators/EntityConverter.enum-dedup.test.ts b/src/__tests__/generators/EntityConverter.enum-dedup.test.ts
@@ -29,7 +29,7 @@ describe('EntityConverter enum deduplication', () => {
         ],
       },
       {
-        name: 'V1_Filter',
+        name: 'V1Filter',
         description: 'A V1 filter',
         attributes: [
           {
@@ -52,7 +52,7 @@ describe('EntityConverter enum deduplication', () => {
 
     // Check that both entities exist
     expect(spec.components?.schemas?.Filter).toBeDefined();
-    expect(spec.components?.schemas?.V1_Filter).toBeDefined();
+    expect(spec.components?.schemas?.V1Filter).toBeDefined();
 
     // Check that FilterContextEnum component is created (named after first entity)
     expect(spec.components?.schemas?.FilterContextEnum).toBeDefined();
@@ -68,7 +68,7 @@ describe('EntityConverter enum deduplication', () => {
 
     // Check that both entities reference the shared component
     const filterSchema = spec.components!.schemas!.Filter;
-    const v1FilterSchema = spec.components!.schemas!.V1_Filter;
+    const v1FilterSchema = spec.components!.schemas!.V1Filter;
 
     // Both should have context property as array with items referencing FilterContext
     expect(filterSchema.properties?.context).toBeDefined();
@@ -173,7 +173,7 @@ describe('EntityConverter enum deduplication', () => {
         ],
       },
       {
-        name: 'V1_Filter',
+        name: 'V1Filter',
         description: 'A V1 filter',
         attributes: [
           {
@@ -190,7 +190,7 @@ describe('EntityConverter enum deduplication', () => {
 
     // Should create separate context components for different enums
     const filterSchema = spec.components!.schemas!.Filter;
-    const v1FilterSchema = spec.components!.schemas!.V1_Filter;
+    const v1FilterSchema = spec.components!.schemas!.V1Filter;
 
     const filterContext1 = filterSchema.properties!.context;
     const filterContext2 = v1FilterSchema.properties!.context;
diff --git a/src/__tests__/generators/EntityConverter.trends-link-inheritance.test.ts b/src/__tests__/generators/EntityConverter.trends-link-inheritance.test.ts
@@ -124,7 +124,7 @@ describe('TrendsLink Entity Inheritance', () => {
     entityConverter.convertEntities(entities, spec);
 
     // Verify Trends::Link has all PreviewCard properties plus its own
-    const trendsLinkSchema = spec.components?.schemas?.Trends_Link;
+    const trendsLinkSchema = spec.components?.schemas?.TrendsLink;
     expect(trendsLinkSchema).toBeDefined();
     expect(trendsLinkSchema?.properties).toBeDefined();
 
diff --git a/src/__tests__/generators/OpenAPIGenerator.enum-refactor.test.ts b/src/__tests__/generators/OpenAPIGenerator.enum-refactor.test.ts
@@ -89,7 +89,7 @@ describe('OpenAPIGenerator enum refactoring', () => {
       spec.components?.schemas?.AccountSettingPrivacyLevelEnum
     ).toBeDefined();
 
-    const settingSchema = spec.components!.schemas!['Account_Setting'];
+    const settingSchema = spec.components!.schemas!['AccountSetting'];
     expect(settingSchema.properties!.privacy_level.$ref).toBe(
       '#/components/schemas/AccountSettingPrivacyLevelEnum'
     );
diff --git a/src/__tests__/generators/OpenAPIGenerator.externalDocs.test.ts b/src/__tests__/generators/OpenAPIGenerator.externalDocs.test.ts
@@ -196,7 +196,7 @@ describe('OpenAPIGenerator ExternalDocs Generation', () => {
 
       const spec = generator.generateSchema(entities, []);
 
-      const trendsLinkSchema = spec.components?.schemas?.Trends_Link;
+      const trendsLinkSchema = spec.components?.schemas?.TrendsLink;
       expect(trendsLinkSchema).toBeDefined();
       expect(trendsLinkSchema?.externalDocs).toBeDefined();
       expect(trendsLinkSchema?.externalDocs?.url).toBe(
@@ -225,7 +225,7 @@ describe('OpenAPIGenerator ExternalDocs Generation', () => {
 
       const spec = generator.generateSchema(entities, []);
 
-      const dimensionSchema = spec.components?.schemas?.Admin_Dimension;
+      const dimensionSchema = spec.components?.schemas?.AdminDimension;
       expect(dimensionSchema).toBeDefined();
       expect(dimensionSchema?.externalDocs).toBeDefined();
       expect(dimensionSchema?.externalDocs?.url).toBe(
@@ -254,7 +254,7 @@ describe('OpenAPIGenerator ExternalDocs Generation', () => {
 
       const spec = generator.generateSchema(entities, []);
 
-      const dimensionDataSchema = spec.components?.schemas?.Admin_DimensionData;
+      const dimensionDataSchema = spec.components?.schemas?.AdminDimensionData;
       expect(dimensionDataSchema).toBeDefined();
       expect(dimensionDataSchema?.externalDocs).toBeDefined();
       expect(dimensionDataSchema?.externalDocs?.url).toBe(
@@ -282,7 +282,7 @@ describe('OpenAPIGenerator ExternalDocs Generation', () => {
 
       const spec = generator.generateSchema(entities, []);
 
-      const adminSchema = spec.components?.schemas?.Admin_CanonicalEmailBlock;
+      const adminSchema = spec.components?.schemas?.AdminCanonicalEmailBlock;
       expect(adminSchema).toBeDefined();
       expect(adminSchema?.externalDocs).toBeDefined();
       expect(adminSchema?.externalDocs?.url).toBe(
diff --git a/src/__tests__/generators/OpenAPIGenerator.test.ts b/src/__tests__/generators/OpenAPIGenerator.test.ts
@@ -188,20 +188,20 @@ describe('OpenAPIGenerator', () => {
 
       const spec = generator.generateSchema(entities, []);
 
-      // Check that schema names are sanitized (:: replaced with _, spaces replaced with _)
-      expect(spec.components?.schemas?.['Admin_DomainAllow']).toBeDefined();
-      expect(spec.components?.schemas?.['Status_Mention']).toBeDefined();
-      expect(spec.components?.schemas?.['Field_entity']).toBeDefined();
+      // Check that schema names are sanitized (:: and spaces converted to PascalCase)
+      expect(spec.components?.schemas?.['AdminDomainAllow']).toBeDefined();
+      expect(spec.components?.schemas?.['StatusMention']).toBeDefined();
+      expect(spec.components?.schemas?.['FieldEntity']).toBeDefined();
 
       // Check that original names with :: and spaces are not present
       expect(spec.components?.schemas?.['Admin::DomainAllow']).toBeUndefined();
       expect(spec.components?.schemas?.['Status::Mention']).toBeUndefined();
       expect(spec.components?.schemas?.['Field entity']).toBeUndefined();
 
       // Check that references are also sanitized
-      const statusMentionSchema = spec.components!.schemas!['Status_Mention'];
+      const statusMentionSchema = spec.components!.schemas!['StatusMention'];
       expect(statusMentionSchema.properties?.['user']?.$ref).toBe(
-        '#/components/schemas/Admin_DomainAllow'
+        '#/components/schemas/AdminDomainAllow'
       );
 
       // Verify all schema names match OpenAPI regex ^[a-zA-Z0-9\.\-_]+$
diff --git a/src/__tests__/generators/OpenAPIGenerator.type-enum-separation.test.ts b/src/__tests__/generators/OpenAPIGenerator.type-enum-separation.test.ts
@@ -136,8 +136,8 @@ describe('OpenAPIGenerator type enum separation', () => {
       '#/components/schemas/PreviewCardTypeEnum'
     );
 
-    // Check that Trends_Link also uses PreviewCardTypeEnum
-    const trendsLinkSchema = schema.components!.schemas!.Trends_Link;
+    // Check that TrendsLink also uses PreviewCardTypeEnum
+    const trendsLinkSchema = schema.components!.schemas!.TrendsLink;
     const trendsLinkTypeProp = trendsLinkSchema.properties!.type;
     expect(trendsLinkTypeProp.$ref).toBe(
       '#/components/schemas/PreviewCardTypeEnum'
diff --git a/src/__tests__/generators/UtilityHelpers.test.ts b/src/__tests__/generators/UtilityHelpers.test.ts
@@ -86,13 +86,44 @@ describe('UtilityHelpers', () => {
   describe('sanitizeSchemaName', () => {
     it('should replace :: with _ and spaces with _', () => {
       expect(utilityHelpers.sanitizeSchemaName('Test::Entity')).toBe(
-        'Test_Entity'
+        'TestEntity'
       );
       expect(utilityHelpers.sanitizeSchemaName('Test Entity')).toBe(
-        'Test_Entity'
+        'TestEntity'
       );
       expect(utilityHelpers.sanitizeSchemaName('Test::Entity Name')).toBe(
-        'Test_Entity_Name'
+        'TestEntityName'
+      );
+    });
+
+    it('should convert underscores to PascalCase', () => {
+      expect(utilityHelpers.sanitizeSchemaName('Status_Tag')).toBe('StatusTag');
+      expect(utilityHelpers.sanitizeSchemaName('Admin_Account')).toBe(
+        'AdminAccount'
+      );
+      expect(utilityHelpers.sanitizeSchemaName('Poll_Option')).toBe('PollOption');
+      expect(utilityHelpers.sanitizeSchemaName('Status_Mention')).toBe(
+        'StatusMention'
+      );
+    });
+
+    it('should handle mixed separators', () => {
+      expect(utilityHelpers.sanitizeSchemaName('Test::Entity_Name')).toBe(
+        'TestEntityName'
+      );
+      expect(utilityHelpers.sanitizeSchemaName('Admin::Account_Setting')).toBe(
+        'AdminAccountSetting'
+      );
+      expect(utilityHelpers.sanitizeSchemaName('Admin::CanonicalEmailBlock')).toBe(
+        'AdminCanonicalEmailBlock'
+      );
+    });
+
+    it('should preserve already PascalCase names', () => {
+      expect(utilityHelpers.sanitizeSchemaName('Account')).toBe('Account');
+      expect(utilityHelpers.sanitizeSchemaName('StatusTag')).toBe('StatusTag');
+      expect(utilityHelpers.sanitizeSchemaName('AdminAccount')).toBe(
+        'AdminAccount'
       );
     });
   });
diff --git a/src/__tests__/integration/filter-context-dedup.test.ts b/src/__tests__/integration/filter-context-dedup.test.ts
@@ -33,13 +33,13 @@ describe('Integration: Filter context deduplication', () => {
       'thread',
     ]);
 
-    // Check that both Filter and V1_Filter exist
+    // Check that both Filter and V1Filter exist
     expect(schema.components?.schemas?.Filter).toBeDefined();
-    expect(schema.components?.schemas?.V1_Filter).toBeDefined();
+    expect(schema.components?.schemas?.V1Filter).toBeDefined();
 
     // Check that both entities reference the shared FilterContext component
     const filterSchema = schema.components!.schemas!.Filter;
-    const v1FilterSchema = schema.components!.schemas!.V1_Filter;
+    const v1FilterSchema = schema.components!.schemas!.V1Filter;
 
     expect(filterSchema.properties?.context).toBeDefined();
     expect(v1FilterSchema.properties?.context).toBeDefined();
@@ -48,12 +48,12 @@ describe('Integration: Filter context deduplication', () => {
     const v1FilterContextProp = v1FilterSchema.properties!.context;
 
     // Filter should not be nullable (added in v4.0.0, before supported v4.3.0),
-    // but V1_Filter should not be nullable (added in v2.4.3, different major)
+    // but V1Filter should not be nullable (added in v2.4.3, different major)
     expect(filterContextProp.type).toEqual('array');
     expect(v1FilterContextProp.type).toBe('array');
 
     // Check that both use the FilterContextEnum schema or have the expected enum values
-    // V1_Filter uses $ref (non-nullable), Filter has inline enum (nullable)
+    // V1Filter uses $ref (non-nullable), Filter has inline enum (nullable)
     expect(v1FilterContextProp.items?.$ref).toBe(
       '#/components/schemas/FilterContextEnum'
     );
@@ -79,7 +79,7 @@ describe('Integration: Filter context deduplication', () => {
     expect(filterContextProp.enum).toBeUndefined();
     expect(v1FilterContextProp.enum).toBeUndefined();
 
-    // V1_Filter (non-nullable) should use shared schema
+    // V1Filter (non-nullable) should use shared schema
     expect(v1FilterContextProp.items?.enum).toBeUndefined();
 
     // Filter (nullable) may have inline enum values instead of shared schema
diff --git a/src/__tests__/integration/trends-link-inheritance.test.ts b/src/__tests__/integration/trends-link-inheritance.test.ts
@@ -49,7 +49,7 @@ describe('TrendsLink Entity Integration Test', () => {
 
     // Verify both schemas exist
     const previewCardSchema = spec.components?.schemas?.PreviewCard;
-    const trendsLinkSchema = spec.components?.schemas?.Trends_Link;
+    const trendsLinkSchema = spec.components?.schemas?.TrendsLink;
 
     expect(previewCardSchema).toBeDefined();
     expect(trendsLinkSchema).toBeDefined();
@@ -89,7 +89,7 @@ describe('TrendsLink Entity Integration Test', () => {
 
     entityConverter.convertEntities(entities, spec);
 
-    const trendsLinkSchema = spec.components?.schemas?.Trends_Link;
+    const trendsLinkSchema = spec.components?.schemas?.TrendsLink;
     expect(trendsLinkSchema?.properties).toBeDefined();
 
     const properties = Object.keys(trendsLinkSchema!.properties!);
diff --git a/src/generators/UtilityHelpers.ts b/src/generators/UtilityHelpers.ts
@@ -41,12 +41,37 @@ class UtilityHelpers {
   }
 
   /**
-   * Sanitize schema name to be OpenAPI compliant
+   * Sanitize schema name to be OpenAPI compliant and convert to PascalCase
    */
   public sanitizeSchemaName(name: string): string {
-    // Replace :: with _ and spaces with _ to make schema names OpenAPI compliant
+    // Replace :: with _ and spaces with _ to normalize separators
     // OpenAPI schema names must match ^[a-zA-Z0-9\.\-_]+$
-    return name.replace(/::/g, '_').replace(/\s+/g, '_');
+    const normalized = name.replace(/::/g, '_').replace(/\s+/g, '_');
+
+    // If no underscores remain and it's already properly cased, return as-is
+    if (!normalized.includes('_')) {
+      // If it's already in PascalCase (starts with uppercase), return as-is
+      if (/^[A-Z]/.test(normalized)) {
+        return normalized;
+      }
+      // Otherwise, just capitalize the first letter
+      return normalized.charAt(0).toUpperCase() + normalized.slice(1);
+    }
+
+    // Convert to PascalCase by splitting on underscores and capitalizing each word
+    // Preserve original casing of words to handle cases like EmailBlock properly
+    return normalized
+      .split('_')
+      .filter((word) => word.length > 0) // Remove empty segments
+      .map((word) => {
+        // If word is all uppercase, convert to proper case
+        if (word === word.toUpperCase()) {
+          return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
+        }
+        // Otherwise just capitalize first letter and preserve rest
+        return word.charAt(0).toUpperCase() + word.slice(1);
+      })
+      .join('');
   }
 }
 
