From c122deb13204aa3a4eac79aef57563d2da76d1b4 Mon Sep 17 00:00:00 2001 From: Thom Werring Date: Sun, 22 Oct 2023 09:52:38 +0200 Subject: [PATCH] Moved split openApi into multiple files and moved them to a separate directory --- src/common/openApi.ts | 147 --------------------------------------- src/cvdocs/experience.ts | 59 ++++++++++++++++ src/cvdocs/intro.ts | 21 ++++++ src/cvdocs/openApi.ts | 91 ++++++++++++++++++++++++ src/cvdocs/skills.ts | 26 +++++++ src/main.ts | 2 +- 6 files changed, 198 insertions(+), 148 deletions(-) delete mode 100644 src/common/openApi.ts create mode 100644 src/cvdocs/experience.ts create mode 100644 src/cvdocs/intro.ts create mode 100644 src/cvdocs/openApi.ts create mode 100644 src/cvdocs/skills.ts diff --git a/src/common/openApi.ts b/src/common/openApi.ts deleted file mode 100644 index fa0d3b4..0000000 --- a/src/common/openApi.ts +++ /dev/null @@ -1,147 +0,0 @@ -import { RedocModule, RedocOptions } from "@juicyllama/nestjs-redoc"; -import { INestApplication } from "@nestjs/common"; -import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger"; -import { skills } from "@/skills/skills"; -import { experiences } from "@/experiences/experiences"; -import { ExperienceType } from "@/experiences/experiences.types"; - -const apiDocument = ( - options: { - title: string; - description: string; - version: `${number}.${number}.${number}${string}` | `${number}.${number}${string}` | `${number}${string}`; - contact: { - name: string; - email: string; - }; - }, - redocOptions: RedocOptions -) => { - redocOptions.title = options.title; - - return new DocumentBuilder() - .setTitle(options.title) - .setDescription(options.description) - .setVersion(options.version) - .setContact(options.contact.name, null, options.contact.email) - .addServer("http://localhost:3000/"); -}; - -const addIntro = (document: DocumentBuilder, redocOptions: RedocOptions): DocumentBuilder => { - const intro = [ - "I'm a software lead with 5+ years of experience in cloud-native development and Agile/Scrum methodologies. I'm passionate about building and leading high-performing teams to deliver scalable and reliable cloud-based applications. I have a proven track record of success in using Node.js, TypeScript, JavaScript, Docker, Kubernetes, AWS, DevOps, Git, microservices, and HAProxy to create and deploy innovative solutions.", - "I'm also a strong communicator and collaborator, and I'm always looking for ways to improve my skills and knowledge. I'm excited about the future of cloud computing, and I'm eager to use my skills and experience to help others achieve their goals.", - ]; - - const introTagGroup = redocOptions.tagGroups.find((tagGroup) => tagGroup.name === "Intro"); - if (!introTagGroup) { - redocOptions.tagGroups.push({ - name: "Intro", - tags: ["Intro"], - }); - } else { - introTagGroup.tags.push("Intro"); - } - - return document.addTag("Intro", intro.join("
")); -}; - -const addSkills = (document: DocumentBuilder, count: number = 5, redocOptions: RedocOptions): DocumentBuilder => { - const introTagGroup = redocOptions.tagGroups.find((tagGroup) => tagGroup.name === "Intro"); - if (!introTagGroup) { - redocOptions.tagGroups.push({ - name: "Intro", - tags: ["Skills"], - }); - } else { - introTagGroup.tags.push("Skills"); - } - - const intro = "A short excerpt of my skills are"; - const skillList = skills - .slice(0, count) - .reduce((list, skill) => list.concat(`
  • ${skill.name} ${skill.description}
    • `), ""); - - return document.addTag("Skills", `${intro}
    `); -}; - -const formatExperience = (experience: ExperienceType) => { - return `${experience.startDate.toLocaleDateString("en-GB")}`; -}; - -const addExperiences = (document: DocumentBuilder, count: number = 5, redocOptions: RedocOptions): DocumentBuilder => { - let experienceTagGroup = redocOptions.tagGroups.find((tagGroup) => tagGroup.name === "Experience"); - if (!experienceTagGroup) { - experienceTagGroup = { - name: "Experience", - tags: ["Experience"], - }; - redocOptions.tagGroups.push(experienceTagGroup); - } - - experiences.slice(0, count).forEach((experience) => { - experienceTagGroup.tags.push(experience.name); - document.addTag(experience.name, formatExperience(experience)); - }); - - return document; -}; - -const initDocs = async ({ - app, - config, - redocOptions, - swaggerUIPath, - redocPath, -}: { - app: INestApplication; - config: DocumentBuilder; - redocOptions: RedocOptions; - swaggerUIPath: string; - redocPath: string; -}): Promise => { - const document = SwaggerModule.createDocument(app, config.build(), { - operationIdFactory: (controllerKey: string, methodKey: string) => - `${methodKey[0].toUpperCase()}${methodKey.substring(1)}`, - }); - - SwaggerModule.setup(swaggerUIPath, app, document); - await RedocModule.setup(redocPath, app, document, redocOptions); -}; - -export default async (app: INestApplication) => { - const redocOptions: RedocOptions = { - logo: { - url: "https://picsum.photos/256/128", - altText: "Thom Werring", - }, - sortPropsAlphabetically: true, - hideDownloadButton: false, - tagGroups: [], - }; - - const config = apiDocument( - { - title: "Thom Werring - CV", - description: "Westerstraat 83
    1521ZB, Wormerveer
    +31 6 37 65 08 49", - version: "1.0.0a", - contact: { - name: "Thom Werring", - email: "cv@t-werring.nl", - }, - }, - redocOptions - ); - - addIntro(config, redocOptions); - addSkills(config, 5, redocOptions); - addExperiences(config, 3, redocOptions); - - await initDocs({ - app, - config, - redocOptions, - swaggerUIPath: "/api", - redocPath: "/docs", - }); -}; diff --git a/src/cvdocs/experience.ts b/src/cvdocs/experience.ts new file mode 100644 index 0000000..f1c0d40 --- /dev/null +++ b/src/cvdocs/experience.ts @@ -0,0 +1,59 @@ +import { ExperienceType } from "@/experiences/experiences.types"; +import { DocumentBuilder } from "@nestjs/swagger"; +import { RedocOptions } from "@juicyllama/nestjs-redoc"; +import { experiences } from "@/experiences/experiences"; + +const formatExperience = (experience: ExperienceType) => { + const workPeriod = `${formatDate(experience.startDate)} - ${ + experience.endDate ? formatDate(experience.endDate) : "present" + }`; + + const company = experience.url + ? `${experience.name}` + : experience.name; + + return `${company}, ${experience.city}
    +${experience.jobTitle}
    +${workPeriod} +

    ${experience.description}

    `; +}; + +const formatDate = (date: Date, locale: string | string[] = "en-GB"): string => { + const dateFormatter = new Intl.DateTimeFormat(locale, { + dateStyle: "long", + }); + const dateParts = dateFormatter.formatToParts(date).reduce>( + (result, datePart: Intl.DateTimeFormatPart) => { + if (datePart.type !== "literal") { + result[datePart.type] = datePart.value; + } + + return result; + }, + { day: "", month: "", year: "" } + ); + + return `${dateParts.month} ${dateParts.year}`; +}; + +export const addExperiences = ( + document: DocumentBuilder, + count: number = 5, + redocOptions: RedocOptions +): DocumentBuilder => { + let experienceTagGroup = redocOptions.tagGroups.find((tagGroup) => tagGroup.name === "Experience"); + if (!experienceTagGroup) { + experienceTagGroup = { + name: "Experience", + tags: ["Experience"], + }; + redocOptions.tagGroups.push(experienceTagGroup); + } + + experiences.slice(0, count).forEach((experience) => { + experienceTagGroup.tags.push(experience.name); + document.addTag(experience.name, formatExperience(experience)); + }); + + return document; +}; diff --git a/src/cvdocs/intro.ts b/src/cvdocs/intro.ts new file mode 100644 index 0000000..6113a42 --- /dev/null +++ b/src/cvdocs/intro.ts @@ -0,0 +1,21 @@ +import { DocumentBuilder } from "@nestjs/swagger"; +import { RedocOptions } from "@juicyllama/nestjs-redoc"; + +export const addIntro = (document: DocumentBuilder, redocOptions: RedocOptions): DocumentBuilder => { + const intro = [ + "I'm a software lead with 5+ years of experience in cloud-native development and Agile/Scrum methodologies. I'm passionate about building and leading high-performing teams to deliver scalable and reliable cloud-based applications. I have a proven track record of success in using Node.js, TypeScript, JavaScript, Docker, Kubernetes, AWS, DevOps, Git, microservices, and HAProxy to create and deploy innovative solutions.", + "I'm also a strong communicator and collaborator, and I'm always looking for ways to improve my skills and knowledge. I'm excited about the future of cloud computing, and I'm eager to use my skills and experience to help others achieve their goals.", + ]; + + const introTagGroup = redocOptions.tagGroups.find((tagGroup) => tagGroup.name === "Intro"); + if (!introTagGroup) { + redocOptions.tagGroups.push({ + name: "Intro", + tags: ["Intro"], + }); + } else { + introTagGroup.tags.push("Intro"); + } + + return document.addTag("Intro", intro.join("
    ")); +}; diff --git a/src/cvdocs/openApi.ts b/src/cvdocs/openApi.ts new file mode 100644 index 0000000..a33c466 --- /dev/null +++ b/src/cvdocs/openApi.ts @@ -0,0 +1,91 @@ +import { RedocModule, RedocOptions } from "@juicyllama/nestjs-redoc"; +import { INestApplication } from "@nestjs/common"; +import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger"; +import { addExperiences } from "@/cvdocs/experience"; +import { addSkills } from "@/cvdocs/skills"; +import { addIntro } from "@/cvdocs/intro"; + +const apiDocument = ( + options: { + title: string; + description: string; + version: `${number}.${number}.${number}${string}` | `${number}.${number}${string}` | `${number}${string}`; + contact: { + name: string; + email: string; + }; + }, + redocOptions: RedocOptions +) => { + redocOptions.title = options.title; + + return new DocumentBuilder() + .setTitle(options.title) + .setDescription(options.description) + .setVersion(options.version) + .setContact(options.contact.name, null, options.contact.email) + .addServer("http://localhost:3000/"); +}; + +const initDocs = async ({ + app, + config, + redocOptions, + swaggerUIPath, + redocPath, +}: { + app: INestApplication; + config: DocumentBuilder; + redocOptions: RedocOptions; + swaggerUIPath?: string; + redocPath?: string; +}): Promise => { + const document = SwaggerModule.createDocument(app, config.build(), { + operationIdFactory: (controllerKey: string, methodKey: string) => + `${methodKey[0].toUpperCase()}${methodKey.substring(1)}`, + }); + + if (swaggerUIPath) { + SwaggerModule.setup(swaggerUIPath, app, document); + } + if (redocPath) { + await RedocModule.setup(redocPath, app, document, redocOptions); + } +}; + +export default async (app: INestApplication) => { + const redocOptions: RedocOptions = { + logo: { + url: "https://picsum.photos/256/128", + altText: "Thom Werring", + }, + sortPropsAlphabetically: true, + hideDownloadButton: false, + tagGroups: [], + }; + + const config = apiDocument( + { + title: "Thom Werring - CV", + description: "Westerstraat 83
    1521ZB, Wormerveer
    +31 6 37 65 08 49", + version: "1.0.0a", + contact: { + name: "Thom Werring", + email: "cv@t-werring.nl", + }, + }, + redocOptions + ); + + addIntro(config, redocOptions); + addSkills(config, 5, redocOptions); + addExperiences(config, 3, redocOptions); + + await initDocs({ + app, + config, + redocOptions, + swaggerUIPath: "/api", + redocPath: "/docs", + }); +}; diff --git a/src/cvdocs/skills.ts b/src/cvdocs/skills.ts new file mode 100644 index 0000000..e4d2d9d --- /dev/null +++ b/src/cvdocs/skills.ts @@ -0,0 +1,26 @@ +import { DocumentBuilder } from "@nestjs/swagger"; +import { RedocOptions } from "@juicyllama/nestjs-redoc"; +import { skills } from "@/skills/skills"; + +export const addSkills = ( + document: DocumentBuilder, + count: number = 5, + redocOptions: RedocOptions +): DocumentBuilder => { + const introTagGroup = redocOptions.tagGroups.find((tagGroup) => tagGroup.name === "Intro"); + if (!introTagGroup) { + redocOptions.tagGroups.push({ + name: "Intro", + tags: ["Skills"], + }); + } else { + introTagGroup.tags.push("Skills"); + } + + const intro = "A short excerpt of my skills are"; + const skillList = skills + .slice(0, count) + .reduce((list, skill) => list.concat(`
  • ${skill.name} ${skill.description}
    • `), ""); + + return document.addTag("Skills", `${intro}
      ${skillList}
    `); +}; diff --git a/src/main.ts b/src/main.ts index 62b41ca..a3ffc2f 100644 --- a/src/main.ts +++ b/src/main.ts @@ -1,6 +1,6 @@ import { NestFactory } from "@nestjs/core"; import { AppModule } from "@/app.module"; -import openApi from "@/common/openApi"; +import openApi from "@/cvdocs/openApi"; async function bootstrap() { const app = await NestFactory.create(AppModule);