interface PluginConfig {
  fields: FieldConfig[];           // Array of field configurations
  defaultIcon?: string;            // Default icon for all badges
  defaultColor?: string;           // Default text color
  defaultBackground?: string;      // Default background color
}

interface SingleBadgeField {
  fieldName: string;               // OpenAPI extension field name (e.g., 'x-roles')
  badge: BadgeConfig;              // Badge styling configuration
  parser?: BadgeParser;            // Optional custom parser function
}

interface BadgeConfig {
  icon?: string;                   // Emoji or text icon
  color?: string;                  // Text color (CSS color value)
  background?: string;             // Background color (CSS color value)
}

interface MultiBadgeField {
  fieldName: string;               // OpenAPI extension field name
  badges: { [key: string]: BadgeConfig }; // Mapping of badge keys to configurations
  parser?: BadgeParser;            // Optional custom parser function
}

interface BadgeParser {
  (value: any): Array<{ key: string; value: any }>;
}

// Example: Custom parser for deprecated fields
const deprecatedParser = (value: { reason: string; since: string; until: string }) => [
  {
    key: 'deprecated',
    value: `${value.reason} (${value.since} - ${value.until})`
  }
];

import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { CustomBadgePlugin } from 'swagger-custom-badges';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const config = new DocumentBuilder()
    .setTitle('API Documentation')
    .setDescription('API with custom badges')
    .setVersion('1.0')
    .build();

  const documentFactory = () => SwaggerModule.createDocument(app, config);
  
  SwaggerModule.setup('docs', app, documentFactory, {
    swaggerOptions: {
      plugins: [
        CustomBadgePlugin({
          fields: [
            {
              fieldName: 'x-roles',
              badges: {
                admin: { icon: '👑', background: '#dc3545' },
                user: { icon: '👤', background: '#28a745' },
                guest: { icon: '🌐', background: '#6c757d' }
              }
            },
            {
              fieldName: 'x-deprecated',
              badge: {
                icon: '⚠️',
                background: '#ffc107',
                color: '#000'
              }
            }
          ],
          defaultIcon: '🏷️',
          defaultColor: 'white',
          defaultBackground: '#6f42c1'
        })
      ]
    }
  });

  await app.listen(3000);
}
bootstrap();

import { Controller, Get } from '@nestjs/common';
import { ApiExtension, ApiOperation } from '@nestjs/swagger';

@Controller('users')
export class UsersController {
  @Get()
  @ApiOperation({ summary: 'Get all users' })
  @ApiExtension('x-roles', ['admin', 'user'])
  getUsers() {
    return [];
  }

  @Get('profile')
  @ApiOperation({ summary: 'Get user profile' })
  @ApiExtension('x-roles', { admin: true, user: true })
  getProfile() {
    return {};
  }

  @Get('legacy')
  @ApiOperation({ summary: 'Legacy endpoint' })
  @ApiExtension('x-deprecated', {
    reason: 'Use /users instead',
    since: '1.0.0',
    until: '2.0.0'
  })
  getLegacy() {
    return {};
  }
}

CustomBadgePlugin({
  fields: [
    {
      fieldName: 'x-auth',
      badges: {
        admin: { icon: '👑', background: '#dc3545' },
        moderator: { icon: '🛡️', background: '#fd7e14' },
        user: { icon: '👤', background: '#28a745' },
        guest: { icon: '🌐', background: '#6c757d' }
      }
    }
  ]
})

CustomBadgePlugin({
  fields: [
    {
      fieldName: 'x-deprecated',
      badge: {
        icon: '⚠️',
        background: '#ffc107',
        color: '#000'
      },
      parser: (value) => [
        {
          key: 'deprecated',
          value: `Deprecated since ${value.since}`
        }
      ]
    }
  ]
})

CustomBadgePlugin({
  fields: [
    {
      fieldName: 'x-environment',
      badges: {
        production: { icon: '🚀', background: '#dc3545' },
        staging: { icon: '🧪', background: '#ffc107' },
        development: { icon: '🔧', background: '#28a745' }
      }
    }
  ]
})

CustomBadgePlugin({
  fields: [
    {
      fieldName: 'x-rate-limit',
      badge: {
        icon: '⏱️',
        background: '#6f42c1'
      },
      parser: (value) => [
        {
          key: 'rate-limit',
          value: `${value.requests}/${value.window}`
        }
      ]
    }
  ]
})

const defaultConfig = {
  fields: [],
  defaultIcon: '🏷️',
  defaultColor: 'white',
  defaultBackground: '#50e3c2'
};