@flowcore/generator-library-template/templates/components/swagger-factory/swagger-factory.ts

A Yeoman generator for adding flowcore library components to a typescript service or application

import swagger, { type ElysiaSwaggerConfig } from "@elysiajs/swagger"
import pgk from "@root/package.json"

export type SwaggerTags = {
  name: string
  description: string
}

export const defaultSwaggerTags: SwaggerTags[] = [
  { name: "health", description: "Get the health of the API. Verifying if it is up and running" },
]

/**
* Converts a string from kebab case to title case.
*
* This function takes a string in kebab case (e.g., "hello-world") and converts it to title case (e.g., "Hello World").
*
* @param kebabCaseString - The string in kebab case to be converted.
* @returns The converted string in title case.
*
* @example
* convertKebabCaseToTitle("hello-world") // Returns: "Hello World"
*/
function convertKebabCaseToTitleCase(kebabCaseString: string): string {
  return kebabCaseString.replace(/-/g, " ").replace(/\b\w/g, (char) => char.toUpperCase())
}

const swaggerFactory = {
  /**
  * This method is used to generate Swagger documentation from the provided tags.
  * It merges the default tags with the provided tags and creates a Swagger object.
  *
  * @param fromTags - The custom tags to be added to the Swagger documentation.
  * @param config - The configuration object for the Swagger documentation.
  * @returns The Swagger documentation object.
  */
  fromTags: (fromTags: SwaggerTags[], config: ElysiaSwaggerConfig = {}) => {
    return swagger({
      documentation: {
        components: {
          securitySchemes: {
            apiKey: {
              type: "apiKey",
              name: "x-secret",
              in: "header",
            },
            bearerAuth: {
              type: "http",
              scheme: "bearer",
              bearerFormat: "JWT",
            },
            oauth2: {
              type: "oauth2",
              clientId: "flowcoreweb",
              flows: {
                authorizationCode: {
                  authorizationUrl: "https://auth.flowcore.io/realms/flowcore/protocol/openid-connect/auth",
                  tokenUrl: "https://auth.flowcore.io/realms/flowcore/protocol/openid-connect/token",
                  redirectUri: "http://localhost:3000/auth/callback",
                  scopes: {
                    openid: "OpenID Connect",
                    profile: "Profile",
                    email: "Email",
                    flowcore_user: "Flowcore User",
                  },
                  selectedScopes: ["openid", "profile", "email", "flowcore_user"],
                },
              },
            },
            // biome-ignore lint/suspicious/noExplicitAny: <explanation>
          } as any,
        },
        tags: [...defaultSwaggerTags, ...fromTags],
        info: {
          title: convertKebabCaseToTitleCase(pgk.name),
          description: pgk.description,
          version: pgk.version,
        },
      },
      ...config,
    })
  },
}
export { swaggerFactory }