Implement metadata types support for exactOptionalPropertyTypes (ve…

…rcel#72936)
adamlaska · Nov 24, 2024 · f3b06b9 · f3b06b9
1 parent 28a25af
commit f3b06b9
Show file tree

Hide file tree

Showing 12 changed files with 1,163 additions and 401 deletions.
diff --git a/packages/next/src/lib/metadata/types/alternative-urls-types.ts b/packages/next/src/lib/metadata/types/alternative-urls-types.ts
@@ -427,23 +427,29 @@ type UnmatchedLang = 'x-default'
 type HrefLang = LangCode | UnmatchedLang
 
 export type Languages<T> = {
-  [s in HrefLang]?: T
+  [s in HrefLang]?: T | undefined
 }
 
 export type AlternateLinkDescriptor = {
-  title?: string
+  title?: string | undefined
   url: string | URL
 }
 
 export type AlternateURLs = {
-  canonical?: null | string | URL | AlternateLinkDescriptor
-  languages?: Languages<null | string | URL | AlternateLinkDescriptor[]>
-  media?: {
-    [media: string]: null | string | URL | AlternateLinkDescriptor[]
-  }
-  types?: {
-    [types: string]: null | string | URL | AlternateLinkDescriptor[]
-  }
+  canonical?: null | string | URL | AlternateLinkDescriptor | undefined
+  languages?:
+    | Languages<null | string | URL | AlternateLinkDescriptor[]>
+    | undefined
+  media?:
+    | {
+        [media: string]: null | string | URL | AlternateLinkDescriptor[]
+      }
+    | undefined
+  types?:
+    | {
+        [types: string]: null | string | URL | AlternateLinkDescriptor[]
+      }
+    | undefined
 }
 
 export type ResolvedAlternateURLs = {

diff --git a/packages/next/src/lib/metadata/types/extra-types.ts b/packages/next/src/lib/metadata/types/extra-types.ts
@@ -3,103 +3,107 @@
 // ref: https://developers.facebook.com/docs/applinks/metadata-reference
 
 export type AppLinks = {
-  ios?: AppLinksApple | Array<AppLinksApple>
-  iphone?: AppLinksApple | Array<AppLinksApple>
-  ipad?: AppLinksApple | Array<AppLinksApple>
-  android?: AppLinksAndroid | Array<AppLinksAndroid>
-  windows_phone?: AppLinksWindows | Array<AppLinksWindows>
-  windows?: AppLinksWindows | Array<AppLinksWindows>
-  windows_universal?: AppLinksWindows | Array<AppLinksWindows>
-  web?: AppLinksWeb | Array<AppLinksWeb>
+  ios?: AppLinksApple | Array<AppLinksApple> | undefined
+  iphone?: AppLinksApple | Array<AppLinksApple> | undefined
+  ipad?: AppLinksApple | Array<AppLinksApple> | undefined
+  android?: AppLinksAndroid | Array<AppLinksAndroid> | undefined
+  windows_phone?: AppLinksWindows | Array<AppLinksWindows> | undefined
+  windows?: AppLinksWindows | Array<AppLinksWindows> | undefined
+  windows_universal?: AppLinksWindows | Array<AppLinksWindows> | undefined
+  web?: AppLinksWeb | Array<AppLinksWeb> | undefined
 }
 export type ResolvedAppLinks = {
-  ios?: Array<AppLinksApple>
-  iphone?: Array<AppLinksApple>
-  ipad?: Array<AppLinksApple>
-  android?: Array<AppLinksAndroid>
-  windows_phone?: Array<AppLinksWindows>
-  windows?: Array<AppLinksWindows>
-  windows_universal?: Array<AppLinksWindows>
-  web?: Array<AppLinksWeb>
+  ios?: Array<AppLinksApple> | undefined
+  iphone?: Array<AppLinksApple> | undefined
+  ipad?: Array<AppLinksApple> | undefined
+  android?: Array<AppLinksAndroid> | undefined
+  windows_phone?: Array<AppLinksWindows> | undefined
+  windows?: Array<AppLinksWindows> | undefined
+  windows_universal?: Array<AppLinksWindows> | undefined
+  web?: Array<AppLinksWeb> | undefined
 }
 export type AppLinksApple = {
   url: string | URL
-  app_store_id?: string | number
-  app_name?: string
+  app_store_id?: string | number | undefined
+  app_name?: string | undefined
 }
 export type AppLinksAndroid = {
   package: string
-  url?: string | URL
-  class?: string
-  app_name?: string
+  url?: string | URL | undefined
+  class?: string | undefined
+  app_name?: string | undefined
 }
 export type AppLinksWindows = {
   url: string | URL
-  app_id?: string
-  app_name?: string
+  app_id?: string | undefined
+  app_name?: string | undefined
 }
 export type AppLinksWeb = {
   url: string | URL
-  should_fallback?: boolean
+  should_fallback?: boolean | undefined
 }
 
 // Apple Itunes APp
 // https://developer.apple.com/documentation/webkit/promoting_apps_with_smart_app_banners
 export type ItunesApp = {
   appId: string
-  appArgument?: string
+  appArgument?: string | undefined
 }
 
 // Viewport meta structure
 // https://developer.mozilla.org/docs/Web/HTML/Viewport_meta_tag
 // intentionally leaving out user-scalable, use a string if you want that behavior
 export type ViewportLayout = {
-  width?: string | number
-  height?: string | number
-  initialScale?: number
-  minimumScale?: number
-  maximumScale?: number
-  userScalable?: boolean
-  viewportFit?: 'auto' | 'cover' | 'contain'
-  interactiveWidget?: 'resizes-visual' | 'resizes-content' | 'overlays-content'
+  width?: string | number | undefined
+  height?: string | number | undefined
+  initialScale?: number | undefined
+  minimumScale?: number | undefined
+  maximumScale?: number | undefined
+  userScalable?: boolean | undefined
+  viewportFit?: 'auto' | 'cover' | 'contain' | undefined
+  interactiveWidget?:
+    | 'resizes-visual'
+    | 'resizes-content'
+    | 'overlays-content'
+    | undefined
 }
 
 // Apple Web App
 // https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html
 // https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html
 export type AppleWebApp = {
   // default true
-  capable?: boolean
-  title?: string
-  startupImage?: AppleImage | Array<AppleImage>
+  capable?: boolean | undefined
+  title?: string | undefined
+  startupImage?: AppleImage | Array<AppleImage> | undefined
   // default "default"
-  statusBarStyle?: 'default' | 'black' | 'black-translucent'
+  statusBarStyle?: 'default' | 'black' | 'black-translucent' | undefined
 }
 export type AppleImage = string | AppleImageDescriptor
 export type AppleImageDescriptor = {
   url: string
-  media?: string
+  media?: string | undefined
 }
 
 export type ResolvedAppleWebApp = {
   capable: boolean
-  title?: string | null
-  startupImage?: AppleImageDescriptor[] | null
-  statusBarStyle?: 'default' | 'black' | 'black-translucent'
+  title?: string | null | undefined
+  startupImage?: AppleImageDescriptor[] | null | undefined
+  statusBarStyle?: 'default' | 'black' | 'black-translucent' | undefined
 }
 
 export type Facebook = FacebookAppId | FacebookAdmins
 export type FacebookAppId = {
   appId: string
-  admins?: never
+  admins?: never | undefined
 }
 export type FacebookAdmins = {
-  appId?: never
+  appId?: never | undefined
   admins: string | string[]
 }
 export type ResolvedFacebook = {
-  appId?: string
-  admins?: string[]
+  appId?: string | undefined
+  admins?: string[] | undefined
 }
 
 // Format Detection
@@ -110,9 +114,9 @@ export type ResolvedFacebook = {
 // that can initiate a phone call
 // https://www.goodemailcode.com/email-code/template.html
 export type FormatDetection = {
-  telephone?: boolean
-  date?: boolean
-  address?: boolean
-  email?: boolean
-  url?: boolean
+  telephone?: boolean | undefined
+  date?: boolean | undefined
+  address?: boolean | undefined
+  email?: boolean | undefined
+  url?: boolean | undefined
 }