Unverified Commit d0ba8003 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Fix viewport typing and refactor constants (#46569)

## Bug

x-ref: https://github.com/vercel/next.js/discussions/46542
Closes NEXT-686

- [x] Related issues linked using `fixes #number`
- [x] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)
parent 0c0318e7
import type { Viewport } from './types/extra-types'
import type { Icons } from './types/metadata-types'
export const ViewPortKeys: { [k in keyof Viewport]: string } = {
width: 'width',
height: 'height',
initialScale: 'initial-scale',
minimumScale: 'minimum-scale',
maximumScale: 'maximum-scale',
viewportFit: 'viewport-fit',
interactiveWidget: 'interactive-widget',
} as const
export const IconKeys: (keyof Icons)[] = ['icon', 'shortcut', 'apple', 'other']
...@@ -194,6 +194,7 @@ describe('accumulateMetadata', () => { ...@@ -194,6 +194,7 @@ describe('accumulateMetadata', () => {
initialScale: 1, initialScale: 1,
minimumScale: 1, minimumScale: 1,
maximumScale: 1, maximumScale: 1,
viewportFit: 'cover',
interactiveWidget: 'overlays-content', interactiveWidget: 'overlays-content',
}, },
}, },
...@@ -203,7 +204,7 @@ describe('accumulateMetadata', () => { ...@@ -203,7 +204,7 @@ describe('accumulateMetadata', () => {
const metadata = await accumulateMetadata(metadataItems) const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({ expect(metadata).toMatchObject({
viewport: viewport:
'width=device-width, height=device-height, initial-scale=1, minimum-scale=1, maximum-scale=1, interactive-widget=overlays-content', 'width=device-width, height=device-height, initial-scale=1, minimum-scale=1, maximum-scale=1, viewport-fit=cover, interactive-widget=overlays-content',
}) })
}) })
}) })
......
...@@ -8,16 +8,7 @@ import type { ...@@ -8,16 +8,7 @@ import type {
import type { Viewport } from '../types/extra-types' import type { Viewport } from '../types/extra-types'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
import { resolveUrl, resolveUrlValuesOfObject } from './resolve-url' import { resolveUrl, resolveUrlValuesOfObject } from './resolve-url'
import { ViewPortKeys } from '../constants'
const viewPortKeys = {
width: 'width',
height: 'height',
initialScale: 'initial-scale',
minimumScale: 'minimum-scale',
maximumScale: 'maximum-scale',
interactiveWidget: 'interactive-widget',
viewportFit: 'viewport-fit',
} as const
export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => { export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => {
if (!themeColor) return null if (!themeColor) return null
...@@ -43,11 +34,11 @@ export const resolveViewport: FieldResolver<'viewport'> = (viewport) => { ...@@ -43,11 +34,11 @@ export const resolveViewport: FieldResolver<'viewport'> = (viewport) => {
resolved = viewport resolved = viewport
} else if (viewport) { } else if (viewport) {
resolved = '' resolved = ''
for (const viewportKey_ in viewPortKeys) { for (const viewportKey_ in ViewPortKeys) {
const viewportKey = viewportKey_ as keyof Viewport const viewportKey = viewportKey_ as keyof Viewport
if (viewport[viewportKey]) { if (viewport[viewportKey]) {
if (resolved) resolved += ', ' if (resolved) resolved += ', '
resolved += `${viewPortKeys[viewportKey]}=${viewport[viewportKey]}` resolved += `${ViewPortKeys[viewportKey]}=${viewport[viewportKey]}`
} }
} }
} }
......
import type { ResolvedMetadata } from '../types/metadata-interface' import type { ResolvedMetadata } from '../types/metadata-interface'
import type { Icon, IconDescriptor, Icons } from '../types/metadata-types' import type { Icon, IconDescriptor } from '../types/metadata-types'
import type { FieldResolver } from '../types/resolvers' import type { FieldResolver } from '../types/resolvers'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
import { isStringOrURL } from './resolve-url' import { isStringOrURL } from './resolve-url'
import { IconKeys } from '../constants'
export function resolveIcon(icon: Icon): IconDescriptor { export function resolveIcon(icon: Icon): IconDescriptor {
if (isStringOrURL(icon)) return { url: icon } if (isStringOrURL(icon)) return { url: icon }
...@@ -10,8 +11,6 @@ export function resolveIcon(icon: Icon): IconDescriptor { ...@@ -10,8 +11,6 @@ export function resolveIcon(icon: Icon): IconDescriptor {
return icon return icon
} }
const IconKeys = ['icon', 'shortcut', 'apple', 'other'] as (keyof Icons)[]
export const resolveIcons: FieldResolver<'icons'> = (icons) => { export const resolveIcons: FieldResolver<'icons'> = (icons) => {
if (!icons) { if (!icons) {
return null return null
......
...@@ -59,6 +59,7 @@ export type Viewport = { ...@@ -59,6 +59,7 @@ export type Viewport = {
initialScale?: number initialScale?: number
minimumScale?: number minimumScale?: number
maximumScale?: number maximumScale?: number
viewportFit?: 'auto' | 'cover' | 'contain'
interactiveWidget?: 'resizes-visual' | 'resizes-content' | 'overlays-content' interactiveWidget?: 'resizes-visual' | 'resizes-content' | 'overlays-content'
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment