Connect, collaborate, and grow with a community of TypeScript developers
Add crude opengraph that's dynamic for challenges (#371)
Sean Boult42ede14a8865
diff --git a/apps/web/package.json b/apps/web/package.jsonindex 039c6f4a..06ce6178 100644--- a/apps/web/package.json+++ b/apps/web/package.json@@ -29,6 +29,7 @@"@types/lodash": "^4.14.195","@uiw/react-md-editor": "^3.23.3","@uploadthing/react": "^5.2.0",+ "@vercel/og": "^0.5.11","clsx": "^2.0.0","cmdk": "^0.2.0","date-fns": "^2.30.0",diff --git a/apps/web/public/typehero.svg b/apps/web/public/typehero.svgdeleted file mode 100644index e69de29b..00000000diff --git a/apps/web/src/app/api/og/route.tsx b/apps/web/src/app/api/og/route.tsxnew file mode 100644index 00000000..de51d301--- /dev/null+++ b/apps/web/src/app/api/og/route.tsx@@ -0,0 +1,66 @@+import { ImageResponse } from '@vercel/og';++export const runtime = 'edge';+export async function GET(request: Request) {+ const { searchParams } = new URL(request.url);+ const hasTitle = searchParams.has('title');+ const title = hasTitle+ ? searchParams.get('title')?.slice(0, 100)+ : 'A fun typescript challenge site';++ return new ImageResponse(+ (+ <div+ style={{+ fontWeight: 'bold',+ background: 'white',+ width: '100%',+ height: '100%',+ display: 'flex',+ alignItems: 'center',+ flexDirection: 'column',+ backgroundColor: '#000',+ color: '#fff',+ }}+ >+ {/* TODO: move this to an import when it works */}+ <svg+ style={{ marginTop: 60 }}+ height="128"+ width="128"+ viewBox="0 0 512 512"+ fill="none"+ xmlns="http://www.w3.org/2000/svg"+ >+ <g clipPath="url(#clip0_1_2)">+ <path+ d="M462 0H50C22.3858 0 0 22.3858 0 50V462C0 489.614 22.3858 512 50 512H462C489.614 512 512 489.614 512 462V50C512 22.3858 489.614 0 462 0Z"+ fill="#3178C6"+ />+ <path+ fill-rule="evenodd"+ clip-rule="evenodd"+ d="M239.78 284.082H304V243H125V284.082H188.906V467H239.78V284.082Z"+ fill="white"+ />+ <path+ d="M303.13 466.986V242.986H349.72V335.818H418.427V242.986H465.13V466.986H418.427V373.827H349.72V466.986H303.13Z"+ fill="white"+ />+ </g>+ <defs>+ <clipPath id="clip0_1_2">+ <rect width="512" height="512" fill="white" />+ </clipPath>+ </defs>+ </svg>+ <p style={{ marginTop: 20, fontSize: 120 }}>Typehero</p>+ <p style={{ marginTop: 60, fontSize: 70 }}>{title}</p>+ </div>+ ),+ {+ width: 1200,+ height: 600,+ },+ );+}diff --git a/apps/web/src/app/challenge/[id]/page.tsx b/apps/web/src/app/challenge/[id]/page.tsxindex c45f3d89..c930225f 100644--- a/apps/web/src/app/challenge/[id]/page.tsx+++ b/apps/web/src/app/challenge/[id]/page.tsx@@ -2,6 +2,7 @@ import { getServerAuthSession } from '@repo/auth/server';import { Description } from '../_components/description';import { Comments } from '../_components/comments';import { getChallengeRouteData } from './getChallengeRouteData';+import { buildMeta } from '~/app/metadata';interface Props {params: {@@ -11,10 +12,10 @@ interface Props {export async function generateMetadata({ params: { id } }: Props) {const challenge = await getChallengeRouteData(id, null);- return {+ return buildMeta({title: challenge.name,description: challenge.shortDescription,- };+ });}export default async function Challenges({ params: { id } }: Props) {const session = await getServerAuthSession();diff --git a/apps/web/src/app/layout.tsx b/apps/web/src/app/layout.tsxindex 10033c24..15e4126b 100644--- a/apps/web/src/app/layout.tsx+++ b/apps/web/src/app/layout.tsx@@ -4,30 +4,16 @@ import { Inter } from 'next/font/google';import type { Metadata } from 'next';import { Toaster } from '@repo/ui';import { Providers } from './providers';+import { buildMeta } from './metadata';import { Navigation } from '~/components/ui/navigation';const inter = Inter({ subsets: ['latin'] });-const OG_IMAGE = '/real-og.png';export async function generateMetadata(): Promise<Metadata> {- const title = 'Type Hero';- const description = 'Level up your typescript skills with interactive exercises';- return {- title,- description,- openGraph: {- images: [OG_IMAGE],- description,- title,- type: 'website',- },- twitter: {- images: [OG_IMAGE],- title,- description,- card: 'summary_large_image',- },- };+ return buildMeta({+ title: 'Typehero',+ description: 'This is the home page',+ });}export default function RootLayout({ children }: { children: React.ReactNode }) {diff --git a/apps/web/src/app/metadata.ts b/apps/web/src/app/metadata.tsnew file mode 100644index 00000000..14dde046--- /dev/null+++ b/apps/web/src/app/metadata.ts@@ -0,0 +1,79 @@+import type { Metadata } from 'next';+import { headers } from 'next/headers';++const tagline = 'Level up your typescript skills with interactive exercises';+const baseMetadata: Metadata = {+ metadataBase: process.env.VERCEL_URL+ ? new URL(`https://${process.env.VERCEL_URL}`)+ : new URL(`http://localhost:${process.env.PORT ?? 3000}`),+ title: {+ default: 'Typehero',+ template: '%s | TypeHero',+ },+ robots: {+ index: true,+ follow: true,+ },+ description: tagline,+ openGraph: {+ title: 'Typehero',+ description: tagline,+ siteName: 'Typehero',+ images: [+ {+ url: encodeURI(`https://${process.env.VERCEL_URL}/api/og?desc=Testing`),+ width: 1920,+ height: 1080,+ },+ ],+ locale: 'en-US',+ type: 'website',+ },+ twitter: {+ title: 'Typehero',+ card: 'summary_large_image',+ images: [+ {+ url: encodeURI(`https://${process.env.VERCEL_URL}/api/og?desc=Testing`),+ width: 1920,+ height: 1080,+ },+ ],+ },+ icons: {+ shortcut: '/favicon.ico',+ },+};++interface BuildMetaParams {+ title: string;+ description?: string;+ ogImage?: NonNullable<NonNullable<Metadata['openGraph']>['images']>;+}++/** Helper to build opengraph metadata with defaults, you can override the defaults by passing in the params */+export const buildMeta = async ({ title, description }: BuildMetaParams): Promise<Metadata> => {+ const headersList = headers();+ const host = headersList.get('host');+ const appUrl = process.env.VERCEL_URL ?? host;+ const ogImageUrl = `https://${appUrl}/api/og?title=${title}`;++ baseMetadata.openGraph!.images = ogImageUrl;+ baseMetadata.twitter!.images = ogImageUrl;++ if (description) {+ baseMetadata.description = description;+ baseMetadata.twitter!.description = description;+ baseMetadata.openGraph!.description = description;+ }++ if (title) {+ baseMetadata.title = title;+ baseMetadata.twitter!.title = title;+ baseMetadata.openGraph!.title = title;+ }++ return baseMetadata;+};++export default baseMetadata;diff --git a/apps/web/src/app/robots.ts b/apps/web/src/app/robots.tsnew file mode 100644index 00000000..3ca175c9--- /dev/null+++ b/apps/web/src/app/robots.ts@@ -0,0 +1,13 @@+import type { MetadataRoute } from 'next';++export default function robots(): MetadataRoute.Robots {+ return {+ rules: {+ userAgent: '*',+ allow: '/api/og/*',+ disallow: '/private/',+ },+ // TODO: add a sitemap+ // sitemap: 'https://typehero.dev/sitemap.xml',+ };+}diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex b49e3726..ec67d4c8 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -94,6 +94,9 @@ importers:'@uploadthing/react':specifier: ^5.2.0+ '@vercel/og':+ specifier: ^0.5.11+ version: 0.5.11clsx:specifier: ^2.0.0version: 2.0.0@@ -421,7 +424,7 @@ importers:dependencies:'@next/eslint-plugin-next':specifier: canary- version: 13.4.16-canary.1+ version: 13.4.13-canary.13'@repo/tsconfig':specifier: workspace:*version: link:../config-typescript@@ -433,7 +436,7 @@ importers:version: 5.62.0([email protected])([email protected])'@vercel/style-guide':specifier: ^4.0.2eslint:specifier: ^8.40.0version: 8.45.0@@ -1476,8 +1479,8 @@ packages:glob: 7.1.7dev: true- /@next/[email protected]:- resolution: {integrity: sha512-0vMvGyeyksJXVsC1y+0Ly3AsybY84h7WDdinppLqS0xKyod972i5gbeGhF0vC2TKVoeCNcUKX+UbazrmBf8Ilw==}+ /@next/[email protected]:+ resolution: {integrity: sha512-lEXi0QLWUuXlMQRLSk/6JUUoOcjACOKbJYPKe0R1XyF5Kf7/Czdm072UJb3betXqiWw5v54GoOOmyDaUDCn5Rw==}dependencies:glob: 7.1.7dev: false@@ -3180,6 +3183,11 @@ packages:react: 18.2.0dev: false+ /@resvg/[email protected]:+ resolution: {integrity: sha512-yi6R0HyHtsoWTRA06Col4WoDs7SvlXU3DLMNP2bdAgs7HK18dTEVl1weXgxRzi8gwLteGUbIg29zulxIB3GSdg==}+ engines: {node: '>= 10'}+ dev: false+/@rushstack/[email protected]:resolution: {integrity: sha512-V+MvGwaHH03hYhY+k6Ef/xKd6RYlc4q8WBx+2ANmipHJcKuktNcI/NgEsJgdSUF6Lw32njT6OnrRsKYCdgHjYw==}@@ -3190,6 +3198,15 @@ packages:selderee: 0.10.0dev: false+ /@shuding/[email protected]:+ resolution: {integrity: sha512-3NgmNyH3l/Hv6EvsWJbsvpcpUba6R8IREQ83nH83cyakCw7uM1arZKNfHwv1Wz6jgqrF/j4x5ELvR6PnK9nTcA==}+ engines: {node: '>= 8.0.0'}+ hasBin: true+ dependencies:+ fflate: 0.7.4+ string.prototype.codepointat: 0.2.1+ dev: false+/@swc/[email protected]:resolution: {integrity: sha512-sJ902EfIzn1Fa+qYmjdQqh8tPsoxyBz+8yBKC2HKUxyezKJFwPGOn7pv4WY6QuQW//ySQi5lJjA/ZT9sNWWNTg==}dependencies:@@ -3665,7 +3682,16 @@ packages:zod: 3.21.4dev: false- /@vercel/[email protected](@next/[email protected])([email protected])([email protected])([email protected]):+ /@vercel/[email protected]:+ resolution: {integrity: sha512-07SDyClsPXod1dReV9wuwk5uEHvJH42V12Ovy005Zp+Hwq3CZEyWa2gRi12HlXCqoIupOG0//LAFBp1Tt2EwjQ==}+ engines: {node: '>=16'}+ dependencies:+ '@resvg/resvg-wasm': 2.4.1+ satori: 0.10.3+ yoga-wasm-web: 0.3.3+ dev: false++ /@vercel/[email protected](@next/[email protected])([email protected])([email protected])([email protected]):resolution: {integrity: sha512-FroL+oOePzhw7n/I+f7zr4WNroGHT/+2TlW6WH9+CVSjMNsEyu7Qstj2mI5gWIBjT1Y2ZImKPppCzI2cIYmNZw==}engines: {node: '>=16'}peerDependencies:@@ -3685,7 +3711,7 @@ packages:dependencies:'@babel/core': 7.22.10'@babel/eslint-parser': 7.22.10(@babel/[email protected])([email protected])- '@next/eslint-plugin-next': 13.4.16-canary.1+ '@next/eslint-plugin-next': 13.4.13-canary.13'@rushstack/eslint-patch': 1.3.2'@typescript-eslint/eslint-plugin': 5.59.1(@typescript-eslint/[email protected])([email protected])([email protected])'@typescript-eslint/parser': 5.62.0([email protected])([email protected])@@ -4069,6 +4095,11 @@ packages:resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==}+ resolution: {integrity: sha512-3XSA2cR/h/73EzlXXdU6YNycmYI7+kicTxks4eJg2g39biHR84slg2+des+p7iHYhbRg/udIS4TD53WabcOUkw==}+ engines: {node: '>= 0.4'}+ dev: false+resolution: {integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==}dev: false@@ -4229,6 +4260,10 @@ packages:resolution: {integrity: sha512-QOSvevhslijgYwRx6Rv7zKdMF8lbRmx+uQGx2+vDc+KI/eBnsy9kit5aj23AgGu3pa4t9AgwbnXWqS+iOY+2aA==}engines: {node: '>= 6'}+ resolution: {integrity: sha512-dU+Tx2fsypxTgtLoE36npi3UqcjSSMNYfkqgmoEhtZrraP5VWq0K7FkWVTYa8eMPtnU/G2txVsfdCJTn9uzpuQ==}+ dev: false+resolution: {integrity: sha512-Wmec9pCBY8CWbmI4HsjBeQLqDTqV91nFVR83DnZpYyRnPI1wePDsTg0bGLPC5VU/3OIZV1fmxEea1b+tFKe86g==}@@ -4486,10 +4521,31 @@ packages:shebang-command: 2.0.0which: 2.0.2+ resolution: {integrity: sha512-2EZLisiZQ+7m4wwur/qiYJRniHX4K5Tc9w93MT3AS0WS1u5kaZ4FKXlOTBhOjc+CgEgPiGY+fX1yWD8UwpEqUA==}+ dev: false++ resolution: {integrity: sha512-9jaqR6e7Ohds+aWwmhe6wILJ99xYQbfmK9QQB9CcMjDbTxPZjwEmUQpU91OG05Xgm8BahT5fW+svbsQGjS/zPg==}+ dev: false++ resolution: {integrity: sha512-FyyrDHZKEjXDpNJYvVsV960FiqQyXc/LlYmsxl2BcdMb2WPx0OGRVgTg55rPSyLSNMqP52R9r8geSp7apN3Ofg==}+ engines: {node: '>=4'}+ dev: false+resolution: {integrity: sha512-HYPSb7y/Z7BNDCOrakL4raGO2zltZkbeXyAd6Tg9obzix6QhzxCotdBl6VT0Dv4vZfJGVz3WL/xaEI9Ly3ul0g==}dev: false+ resolution: {integrity: sha512-e8RKaLXMOFii+02mOlqwjbD00KSEKqblnpO9e++1aXS1fPQOpS1YoqdVHBqPjHNoxeF2mimzVqawm2KCbEdtHQ==}+ dependencies:+ camelize: 1.0.1+ css-color-keywords: 1.0.0+ postcss-value-parser: 4.2.0+ dev: false+resolution: {integrity: sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==}engines: {node: '>=4'}@@ -4754,6 +4810,10 @@ packages:resolution: {integrity: sha512-1JkvV2sgEGTDXjdsaQCeSwYYuhLRphRpc+g6EHTFELJXEiznLt3/0pZ9JuAOQ5p2rI3YxKTbivtvajirIfhrEQ==}+ resolution: {integrity: sha512-97g6QgOk8zlDRdgq1WxwgTMgEWGVAQvB5Fdpgc1MkNy56la5SKP9GsMXKDOdqwn90/41a8yPwIGk1Y6WVbeMQA==}+ dev: false+resolution: {integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==}@@ -5122,6 +5182,10 @@ packages:resolution: {integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==}engines: {node: '>=6'}+ resolution: {integrity: sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==}+ dev: false+resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==}engines: {node: '>=0.8.0'}@@ -5702,6 +5766,10 @@ packages:web-streams-polyfill: 3.2.1dev: true+ resolution: {integrity: sha512-5u2V/CDW15QM1XbbgS+0DfPxVB+jUKhWEKuuFuHncbk3tEEqzmoXL+2KyOFuKGqOnmdIy0/davWF1CkuwtibCw==}+ dev: false+resolution: {integrity: sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==}engines: {node: ^10.12.0 || >=12.0.0}@@ -6201,6 +6269,11 @@ packages:space-separated-tokens: 2.0.2dev: false+ resolution: {integrity: sha512-Ox1pJVrDCyGHMG9CFg1tmrRUMRPRsAWYc/PinY0XzJU4K7y7vjNoLKIQ7BR5UJMCxNN8EM1MNDmHWA/B3aZUuw==}+ engines: {node: '>=6'}+ dev: false+resolution: {integrity: sha512-tzcUFauisWKNHaRkN4Wjl/ZA07gENAjFl3J/c480dprkGTg5EQstgaNFqBfUqCq54kZRIEcreTsAgF/m2quD7A==}dev: false@@ -6751,6 +6824,13 @@ packages:resolution: {integrity: sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ==}engines: {node: '>=10'}+ resolution: {integrity: sha512-MHp03UImeVhB7XZtjd0E4n6+3xr5Dq/9xI/5FptGk5FrbDR3zagPa2DS6U8ks/3HjbKWG9Q1M2ufOzxV2qLYSQ==}+ dependencies:+ base64-js: 0.0.8+ unicode-trie: 2.0.0+ dev: false+resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==}@@ -7691,12 +7771,23 @@ packages:engines: {node: '>=6'}dev: false+ resolution: {integrity: sha512-NUcwaKxUxWrZLpDG+z/xZaCgQITkA/Dv4V/T6bw7VON6l1Xz/VnrBqrYjZQ12TamKHzITTfOEIYUj48y2KXImA==}+ dev: false+resolution: {integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==}engines: {node: '>=6'}dependencies:callsites: 3.1.0+ resolution: {integrity: sha512-bwS/GGIFV3b6KS4uwpzCFj4w297Yl3uqnSgIPsoQkx7GMLROXfMnWvxfNkL0oh8HVhZA4hvJoEoEIqonfJ3BWg==}+ dependencies:+ color-name: 1.1.4+ hex-rgb: 4.3.0+ dev: false+resolution: {integrity: sha512-kkywGpCcRYhqQIchaWqZ875wzpS/bMKhz5HnN3p7wveJTkTtyAB/AlnS0f8DFSqYW1T82t6yEAkEcB+A1I3MbQ==}dependencies:@@ -8763,6 +8854,22 @@ packages:regexp-tree: 0.1.27dev: false+ resolution: {integrity: sha512-8tZPu7AGiRWimbOyja1s2HK0hEC4DacZ8cAKDITxlVI5tKQZbOuMiVgSB50CABwc0I4Imgtkq7o9Egj1WOJTKg==}+ engines: {node: '>=16'}+ dependencies:+ '@shuding/opentype.js': 1.4.0-beta.0+ css-background-parser: 0.1.0+ css-box-shadow: 1.0.0-3+ css-to-react-native: 3.2.0+ emoji-regex: 10.2.1+ escape-html: 1.0.3+ linebreak: 1.1.0+ parse-css-color: 0.2.1+ postcss-value-parser: 4.2.0+ yoga-wasm-web: 0.3.3+ dev: false+resolution: {integrity: sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==}dependencies:@@ -8943,6 +9050,10 @@ packages:engines: {node: '>=10.0.0'}dev: false+ resolution: {integrity: sha512-2cBVCj6I4IOvEnjgO/hWqXjqBGsY+zwPmHl12Srk9IXSZ56Jwwmy+66XO5Iut/oQVR7t5ihYdLB0GMa4alEUcg==}+ dev: false+resolution: {integrity: sha512-6zOCOcJ+RJAQshcTvXPHoxoQGONa3e/Lqx90wUA+wEzX78sg5Bo+1tQo4N0pohS0erG9qtCqJDjNCQBjeWVxyg==}dependencies:@@ -9238,6 +9349,10 @@ packages:dependencies:any-promise: 1.3.0+ resolution: {integrity: sha512-pkY1fj1cKHb2seWDy0B16HeWyczlJA9/WW3u3c4z/NiWDsO3DOU5D7nhTLE9CF0yXv/QZFY7sEJmj24dK+Rrqw==}+ dev: false+resolution: {integrity: sha512-KxVu8EYHDPBdUYdKZdKtU2aj2XfEx9AfjXxE/Aj0vT06w2icA09Vus1rh6eSu1y01akYg6BjIK/hxyLJINoMLQ==}engines: {node: '>=12'}@@ -9494,6 +9609,13 @@ packages:has-symbols: 1.0.3which-boxed-primitive: 1.0.2+ resolution: {integrity: sha512-x7bc76x0bm4prf1VLg79uhAzKw8DVboClSN5VxJuQ+LKDOVEW9CdH+VY7SP+vX7xCYQqzzgQpFqz15zeLvAtZQ==}+ dependencies:+ pako: 0.2.9+ tiny-inflate: 1.0.3+ dev: false+resolution: {integrity: sha512-pUSWAi/RAnVy1Pif2kAoeWNBa3JVrx0MId2LASj8G+7AiHWoKZNTomq6LG326T68U7/e263X6fTdcXIy7XnF7Q==}dependencies:@@ -9875,6 +9997,10 @@ packages:resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==}engines: {node: '>=10'}+ resolution: {integrity: sha512-N+d4UJSJbt/R3wqY7Coqs5pcV0aUj2j9IaQ3rNj9bVCLld8tTGKRa2USARjnvZJWVx1NDmQev8EknoczaOQDOA==}+ dev: false+resolution: {integrity: sha512-m46AKbrzKVzOzs/DZgVnG5H55N1sv1M8qZU3A8RIKbs3mrACDNeIOeilDymVb2HdmP8uwshOCF4uJ8uM9rCqJw==}dev: false