import { createDefaultMetadata, createDefaultViewport } from "./default-metadata"; import { resolveOpenGraph, resolveTwitter } from "./resolvers/resolve-opengraph"; import { resolveTitle } from "./resolvers/resolve-title"; import { resolveAsArrayOrUndefined } from "./generate/utils"; import { isClientReference } from "../client-reference"; import { getComponentTypeModule, getLayoutOrPageModule } from "../../server/lib/app-dir-module"; import { interopDefault } from "../interop-default"; import { resolveAlternates, resolveAppleWebApp, resolveAppLinks, resolveRobots, resolveThemeColor, resolveVerification, resolveItunes, resolveFacebook } from "./resolvers/resolve-basics"; import { resolveIcons } from "./resolvers/resolve-icons"; import { getTracer } from "../../server/lib/trace/tracer"; import { ResolveMetadataSpan } from "../../server/lib/trace/constants"; import { PAGE_SEGMENT_KEY } from "../../shared/lib/segment"; import * as Log from "../../build/output/log"; function isFavicon(icon) { if (!icon) { return false; } // turbopack appends a hash to all images return (icon.url === "/favicon.ico" || icon.url.toString().startsWith("/favicon.ico?")) && icon.type === "image/x-icon"; } function mergeStaticMetadata(source, target, staticFilesMetadata, metadataContext, titleTemplates, leafSegmentStaticIcons) { var _source_twitter, _source_openGraph; if (!staticFilesMetadata) return; const { icon, apple, openGraph, twitter, manifest } = staticFilesMetadata; // Keep updating the static icons in the most leaf node if (icon) { leafSegmentStaticIcons.icon = icon; } if (apple) { leafSegmentStaticIcons.apple = apple; } // file based metadata is specified and current level metadata twitter.images is not specified if (twitter && !(source == null ? void 0 : (_source_twitter = source.twitter) == null ? void 0 : _source_twitter.hasOwnProperty("images"))) { const resolvedTwitter = resolveTwitter({ ...target.twitter, images: twitter }, target.metadataBase, metadataContext, titleTemplates.twitter); target.twitter = resolvedTwitter; } // file based metadata is specified and current level metadata openGraph.images is not specified if (openGraph && !(source == null ? void 0 : (_source_openGraph = source.openGraph) == null ? void 0 : _source_openGraph.hasOwnProperty("images"))) { const resolvedOpenGraph = resolveOpenGraph({ ...target.openGraph, images: openGraph }, target.metadataBase, metadataContext, titleTemplates.openGraph); target.openGraph = resolvedOpenGraph; } if (manifest) { target.manifest = manifest; } return target; } // Merge the source metadata into the resolved target metadata. function mergeMetadata({ source, target, staticFilesMetadata, titleTemplates, metadataContext, buildState, leafSegmentStaticIcons }) { // If there's override metadata, prefer it otherwise fallback to the default metadata. const metadataBase = typeof (source == null ? void 0 : source.metadataBase) !== "undefined" ? source.metadataBase : target.metadataBase; for(const key_ in source){ const key = key_; switch(key){ case "title": { target.title = resolveTitle(source.title, titleTemplates.title); break; } case "alternates": { target.alternates = resolveAlternates(source.alternates, metadataBase, metadataContext); break; } case "openGraph": { target.openGraph = resolveOpenGraph(source.openGraph, metadataBase, metadataContext, titleTemplates.openGraph); break; } case "twitter": { target.twitter = resolveTwitter(source.twitter, metadataBase, metadataContext, titleTemplates.twitter); break; } case "facebook": target.facebook = resolveFacebook(source.facebook); break; case "verification": target.verification = resolveVerification(source.verification); break; case "icons": { target.icons = resolveIcons(source.icons); break; } case "appleWebApp": target.appleWebApp = resolveAppleWebApp(source.appleWebApp); break; case "appLinks": target.appLinks = resolveAppLinks(source.appLinks); break; case "robots": { target.robots = resolveRobots(source.robots); break; } case "archives": case "assets": case "bookmarks": case "keywords": { target[key] = resolveAsArrayOrUndefined(source[key]); break; } case "authors": { target[key] = resolveAsArrayOrUndefined(source.authors); break; } case "itunes": { target[key] = resolveItunes(source.itunes, metadataBase, metadataContext); break; } // directly assign fields that fallback to null case "applicationName": case "description": case "generator": case "creator": case "publisher": case "category": case "classification": case "referrer": case "formatDetection": case "manifest": // @ts-ignore TODO: support inferring target[key] = source[key] || null; break; case "other": target.other = Object.assign({}, target.other, source.other); break; case "metadataBase": target.metadataBase = metadataBase; break; default: { if ((key === "viewport" || key === "themeColor" || key === "colorScheme") && source[key] != null) { buildState.warnings.add(`Unsupported metadata ${key} is configured in metadata export in ${metadataContext.pathname}. Please move it to viewport export instead.\nRead more: https://nextjs.org/docs/app/api-reference/functions/generate-viewport`); } break; } } } mergeStaticMetadata(source, target, staticFilesMetadata, metadataContext, titleTemplates, leafSegmentStaticIcons); } function mergeViewport({ target, source }) { if (!source) return; for(const key_ in source){ const key = key_; switch(key){ case "themeColor": { target.themeColor = resolveThemeColor(source.themeColor); break; } case "colorScheme": target.colorScheme = source.colorScheme || null; break; default: if (typeof source[key] !== "undefined") { // @ts-ignore viewport properties target[key] = source[key]; } break; } } } async function getDefinedViewport(mod, props, tracingProps) { if (isClientReference(mod)) { return null; } if (typeof mod.generateViewport === "function") { const { route } = tracingProps; return (parent)=>getTracer().trace(ResolveMetadataSpan.generateViewport, { spanName: `generateViewport ${route}`, attributes: { "next.page": route } }, ()=>mod.generateViewport(props, parent)); } return mod.viewport || null; } async function getDefinedMetadata(mod, props, tracingProps) { // Layer is a client component, we just skip it. It can't have metadata exported. // Return early to avoid accessing properties error for client references. if (isClientReference(mod)) { return null; } if (typeof mod.generateMetadata === "function") { const { route } = tracingProps; return (parent)=>getTracer().trace(ResolveMetadataSpan.generateMetadata, { spanName: `generateMetadata ${route}`, attributes: { "next.page": route } }, ()=>mod.generateMetadata(props, parent)); } return mod.metadata || null; } async function collectStaticImagesFiles(metadata, props, type) { var _this; if (!(metadata == null ? void 0 : metadata[type])) return undefined; const iconPromises = metadata[type].map(async (imageModule)=>interopDefault(await imageModule(props))); return (iconPromises == null ? void 0 : iconPromises.length) > 0 ? (_this = await Promise.all(iconPromises)) == null ? void 0 : _this.flat() : undefined; } async function resolveStaticMetadata(components, props) { const { metadata } = components; if (!metadata) return null; const [icon, apple, openGraph, twitter] = await Promise.all([ collectStaticImagesFiles(metadata, props, "icon"), collectStaticImagesFiles(metadata, props, "apple"), collectStaticImagesFiles(metadata, props, "openGraph"), collectStaticImagesFiles(metadata, props, "twitter") ]); const staticMetadata = { icon, apple, openGraph, twitter, manifest: metadata.manifest }; return staticMetadata; } // [layout.metadata, static files metadata] -> ... -> [page.metadata, static files metadata] export async function collectMetadata({ tree, metadataItems, errorMetadataItem, props, route, errorConvention }) { let mod; let modType; const hasErrorConventionComponent = Boolean(errorConvention && tree[2][errorConvention]); if (errorConvention) { mod = await getComponentTypeModule(tree, "layout"); modType = errorConvention; } else { [mod, modType] = await getLayoutOrPageModule(tree); } if (modType) { route += `/${modType}`; } const staticFilesMetadata = await resolveStaticMetadata(tree[2], props); const metadataExport = mod ? await getDefinedMetadata(mod, props, { route }) : null; const viewportExport = mod ? await getDefinedViewport(mod, props, { route }) : null; metadataItems.push([ metadataExport, staticFilesMetadata, viewportExport ]); if (hasErrorConventionComponent && errorConvention) { const errorMod = await getComponentTypeModule(tree, errorConvention); const errorViewportExport = errorMod ? await getDefinedViewport(errorMod, props, { route }) : null; const errorMetadataExport = errorMod ? await getDefinedMetadata(errorMod, props, { route }) : null; errorMetadataItem[0] = errorMetadataExport; errorMetadataItem[1] = staticFilesMetadata; errorMetadataItem[2] = errorViewportExport; } } export async function resolveMetadataItems({ tree, parentParams, metadataItems, errorMetadataItem, treePrefix = [], getDynamicParamFromSegment, searchParams, errorConvention }) { const [segment, parallelRoutes, { page }] = tree; const currentTreePrefix = [ ...treePrefix, segment ]; const isPage = typeof page !== "undefined"; // Handle dynamic segment params. const segmentParam = getDynamicParamFromSegment(segment); /** * Create object holding the parent params and current params */ const currentParams = // Handle null case where dynamic param is optional segmentParam && segmentParam.value !== null ? { ...parentParams, [segmentParam.param]: segmentParam.value } : parentParams; let layerProps; if (isPage) { layerProps = { params: currentParams, searchParams }; } else { layerProps = { params: currentParams }; } await collectMetadata({ tree, metadataItems, errorMetadataItem, errorConvention, props: layerProps, route: currentTreePrefix// __PAGE__ shouldn't be shown in a route .filter((s)=>s !== PAGE_SEGMENT_KEY).join("/") }); for(const key in parallelRoutes){ const childTree = parallelRoutes[key]; await resolveMetadataItems({ tree: childTree, metadataItems, errorMetadataItem, parentParams: currentParams, treePrefix: currentTreePrefix, searchParams, getDynamicParamFromSegment, errorConvention }); } if (Object.keys(parallelRoutes).length === 0 && errorConvention) { // If there are no parallel routes, place error metadata as the last item. // e.g. layout -> layout -> not-found metadataItems.push(errorMetadataItem); } return metadataItems; } const isTitleTruthy = (title)=>!!(title == null ? void 0 : title.absolute); const hasTitle = (metadata)=>isTitleTruthy(metadata == null ? void 0 : metadata.title); function inheritFromMetadata(target, metadata) { if (target) { if (!hasTitle(target) && hasTitle(metadata)) { target.title = metadata.title; } if (!target.description && metadata.description) { target.description = metadata.description; } } } const commonOgKeys = [ "title", "description", "images" ]; function postProcessMetadata(metadata, favicon, titleTemplates, metadataContext) { const { openGraph, twitter } = metadata; if (openGraph) { // If there's openGraph information but not configured in twitter, // inherit them from openGraph metadata. let autoFillProps = {}; const hasTwTitle = hasTitle(twitter); const hasTwDescription = twitter == null ? void 0 : twitter.description; const hasTwImages = Boolean((twitter == null ? void 0 : twitter.hasOwnProperty("images")) && twitter.images); if (!hasTwTitle) { if (isTitleTruthy(openGraph.title)) { autoFillProps.title = openGraph.title; } else if (metadata.title && isTitleTruthy(metadata.title)) { autoFillProps.title = metadata.title; } } if (!hasTwDescription) autoFillProps.description = openGraph.description || metadata.description || undefined; if (!hasTwImages) autoFillProps.images = openGraph.images; if (Object.keys(autoFillProps).length > 0) { const partialTwitter = resolveTwitter(autoFillProps, metadata.metadataBase, metadataContext, titleTemplates.twitter); if (metadata.twitter) { metadata.twitter = Object.assign({}, metadata.twitter, { ...!hasTwTitle && { title: partialTwitter == null ? void 0 : partialTwitter.title }, ...!hasTwDescription && { description: partialTwitter == null ? void 0 : partialTwitter.description }, ...!hasTwImages && { images: partialTwitter == null ? void 0 : partialTwitter.images } }); } else { metadata.twitter = partialTwitter; } } } // If there's no title and description configured in openGraph or twitter, // use the title and description from metadata. inheritFromMetadata(openGraph, metadata); inheritFromMetadata(twitter, metadata); if (favicon) { if (!metadata.icons) { metadata.icons = { icon: [], apple: [] }; } metadata.icons.icon.unshift(favicon); } return metadata; } function collectMetadataExportPreloading(results, dynamicMetadataExportFn, resolvers) { const result = dynamicMetadataExportFn(new Promise((resolve)=>{ resolvers.push(resolve); })); if (result instanceof Promise) { // since we eager execute generateMetadata and // they can reject at anytime we need to ensure // we attach the catch handler right away to // prevent unhandled rejections crashing the process result.catch((err)=>{ return { __nextError: err }; }); } results.push(result); } async function getMetadataFromExport(getPreloadMetadataExport, dynamicMetadataResolveState, metadataItems, currentIndex, resolvedMetadata, metadataResults) { const metadataExport = getPreloadMetadataExport(metadataItems[currentIndex]); const dynamicMetadataResolvers = dynamicMetadataResolveState.resolvers; let metadata = null; if (typeof metadataExport === "function") { // Only preload at the beginning when resolves are empty if (!dynamicMetadataResolvers.length) { for(let j = currentIndex; j < metadataItems.length; j++){ const preloadMetadataExport = getPreloadMetadataExport(metadataItems[j]); // call each `generateMetadata function concurrently and stash their resolver if (typeof preloadMetadataExport === "function") { collectMetadataExportPreloading(metadataResults, preloadMetadataExport, dynamicMetadataResolvers); } } } const resolveParent = dynamicMetadataResolvers[dynamicMetadataResolveState.resolvingIndex]; const metadataResult = metadataResults[dynamicMetadataResolveState.resolvingIndex++]; // In dev we clone and freeze to prevent relying on mutating resolvedMetadata directly. // In prod we just pass resolvedMetadata through without any copying. const currentResolvedMetadata = process.env.NODE_ENV === "development" ? Object.freeze(require("./clone-metadata").cloneMetadata(resolvedMetadata)) : resolvedMetadata; // This resolve should unblock the generateMetadata function if it awaited the parent // argument. If it didn't await the parent argument it might already have a value since it was // called concurrently. Regardless we await the return value before continuing on to the next layer resolveParent(currentResolvedMetadata); metadata = metadataResult instanceof Promise ? await metadataResult : metadataResult; if (metadata && typeof metadata === "object" && "__nextError" in metadata) { // re-throw caught metadata error from preloading throw metadata["__nextError"]; } } else if (metadataExport !== null && typeof metadataExport === "object") { // This metadataExport is the object form metadata = metadataExport; } return metadata; } export async function accumulateMetadata(metadataItems, metadataContext) { const resolvedMetadata = createDefaultMetadata(); const metadataResults = []; let titleTemplates = { title: null, twitter: null, openGraph: null }; // Loop over all metadata items again, merging synchronously any static object exports, // awaiting any static promise exports, and resolving parent metadata and awaiting any generated metadata const dynamicMetadataResolvers = { resolvers: [], resolvingIndex: 0 }; const buildState = { warnings: new Set() }; let favicon; // Collect the static icons in the most leaf node, // since we don't collect all the static metadata icons in the parent segments. const leafSegmentStaticIcons = { icon: [], apple: [] }; for(let i = 0; i < metadataItems.length; i++){ var _staticFilesMetadata_icon; const staticFilesMetadata = metadataItems[i][1]; // Treat favicon as special case, it should be the first icon in the list // i <= 1 represents root layout, and if current page is also at root if (i <= 1 && isFavicon(staticFilesMetadata == null ? void 0 : (_staticFilesMetadata_icon = staticFilesMetadata.icon) == null ? void 0 : _staticFilesMetadata_icon[0])) { var _staticFilesMetadata_icon1; const iconMod = staticFilesMetadata == null ? void 0 : (_staticFilesMetadata_icon1 = staticFilesMetadata.icon) == null ? void 0 : _staticFilesMetadata_icon1.shift(); if (i === 0) favicon = iconMod; } const metadata = await getMetadataFromExport((metadataItem)=>metadataItem[0], dynamicMetadataResolvers, metadataItems, i, resolvedMetadata, metadataResults); mergeMetadata({ target: resolvedMetadata, source: metadata, metadataContext, staticFilesMetadata, titleTemplates, buildState, leafSegmentStaticIcons }); // If the layout is the same layer with page, skip the leaf layout and leaf page // The leaf layout and page are the last two items if (i < metadataItems.length - 2) { var _resolvedMetadata_title, _resolvedMetadata_openGraph, _resolvedMetadata_twitter; titleTemplates = { title: ((_resolvedMetadata_title = resolvedMetadata.title) == null ? void 0 : _resolvedMetadata_title.template) || null, openGraph: ((_resolvedMetadata_openGraph = resolvedMetadata.openGraph) == null ? void 0 : _resolvedMetadata_openGraph.title.template) || null, twitter: ((_resolvedMetadata_twitter = resolvedMetadata.twitter) == null ? void 0 : _resolvedMetadata_twitter.title.template) || null }; } } if (leafSegmentStaticIcons.icon.length > 0 || leafSegmentStaticIcons.apple.length > 0) { if (!resolvedMetadata.icons) { resolvedMetadata.icons = { icon: [], apple: [] }; if (leafSegmentStaticIcons.icon.length > 0) { resolvedMetadata.icons.icon.unshift(...leafSegmentStaticIcons.icon); } if (leafSegmentStaticIcons.apple.length > 0) { resolvedMetadata.icons.apple.unshift(...leafSegmentStaticIcons.apple); } } } // Only log warnings if there are any, and only once after the metadata resolving process is finished if (buildState.warnings.size > 0) { for (const warning of buildState.warnings){ Log.warn(warning); } } return postProcessMetadata(resolvedMetadata, favicon, titleTemplates, metadataContext); } export async function accumulateViewport(metadataItems) { const resolvedViewport = createDefaultViewport(); const viewportResults = []; const dynamicMetadataResolvers = { resolvers: [], resolvingIndex: 0 }; for(let i = 0; i < metadataItems.length; i++){ const viewport = await getMetadataFromExport((metadataItem)=>metadataItem[2], dynamicMetadataResolvers, metadataItems, i, resolvedViewport, viewportResults); mergeViewport({ target: resolvedViewport, source: viewport }); } return resolvedViewport; } export async function resolveMetadata({ tree, parentParams, metadataItems, errorMetadataItem, getDynamicParamFromSegment, searchParams, errorConvention, metadataContext }) { const resolvedMetadataItems = await resolveMetadataItems({ tree, parentParams, metadataItems, errorMetadataItem, getDynamicParamFromSegment, searchParams, errorConvention }); let error; let metadata = createDefaultMetadata(); let viewport = createDefaultViewport(); try { viewport = await accumulateViewport(resolvedMetadataItems); metadata = await accumulateMetadata(resolvedMetadataItems, metadataContext); } catch (err) { error = err; } return [ error, metadata, viewport ]; } //# sourceMappingURL=resolve-metadata.js.map