File size: 4,789 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
import type {
CollectingMetadata,
PossibleStaticMetadataFileNameConvention,
} from './types'
import path from 'path'
import { stringify } from 'querystring'
import { STATIC_METADATA_IMAGES } from '../../../../lib/metadata/is-metadata-route'
import { WEBPACK_RESOURCE_QUERIES } from '../../../../lib/constants'
import type { MetadataResolver } from '../next-app-loader'
import type { PageExtensions } from '../../../page-extensions-type'
const METADATA_TYPE = 'metadata'
const NUMERIC_SUFFIX_ARRAY = Array(10).fill(0)
// Produce all compositions with filename (icon, apple-icon, etc.) with extensions (png, jpg, etc.)
async function enumMetadataFiles(
dir: string,
filename: string,
extensions: readonly string[],
{
metadataResolver,
// When set to true, possible filename without extension could: icon, icon0, ..., icon9
numericSuffix,
}: {
metadataResolver: MetadataResolver
numericSuffix: boolean
}
): Promise<string[]> {
const collectedFiles: string[] = []
// Collect <filename>.<ext>, <filename>[].<ext>
const possibleFileNames = [filename].concat(
numericSuffix
? NUMERIC_SUFFIX_ARRAY.map((_, index) => filename + index)
: []
)
for (const name of possibleFileNames) {
const resolved = await metadataResolver(dir, name, extensions)
if (resolved) {
collectedFiles.push(resolved)
}
}
return collectedFiles
}
export async function createStaticMetadataFromRoute(
resolvedDir: string,
{
segment,
metadataResolver,
isRootLayoutOrRootPage,
pageExtensions,
basePath,
}: {
segment: string
metadataResolver: MetadataResolver
isRootLayoutOrRootPage: boolean
pageExtensions: PageExtensions
basePath: string
}
) {
let hasStaticMetadataFiles = false
const staticImagesMetadata: CollectingMetadata = {
icon: [],
apple: [],
twitter: [],
openGraph: [],
manifest: undefined,
}
async function collectIconModuleIfExists(
type: PossibleStaticMetadataFileNameConvention
) {
if (type === 'manifest') {
const staticManifestExtension = ['webmanifest', 'json']
const manifestFile = await enumMetadataFiles(
resolvedDir,
'manifest',
staticManifestExtension.concat(pageExtensions),
{ metadataResolver, numericSuffix: false }
)
if (manifestFile.length > 0) {
hasStaticMetadataFiles = true
const { name, ext } = path.parse(manifestFile[0])
const extension = staticManifestExtension.includes(ext.slice(1))
? ext.slice(1)
: 'webmanifest'
staticImagesMetadata.manifest = JSON.stringify(
`${basePath}/${name}.${extension}`
)
}
return
}
const isFavicon = type === 'favicon'
const resolvedMetadataFiles = await enumMetadataFiles(
resolvedDir,
STATIC_METADATA_IMAGES[type].filename,
[
...STATIC_METADATA_IMAGES[type].extensions,
...(isFavicon ? [] : pageExtensions),
],
{ metadataResolver, numericSuffix: !isFavicon }
)
resolvedMetadataFiles
.sort((a, b) => a.localeCompare(b))
.forEach((filepath) => {
const imageModuleImportSource = `next-metadata-image-loader?${stringify(
{
type,
segment,
basePath,
pageExtensions,
}
// WEBPACK_RESOURCE_QUERIES.metadata query here only for filtering out applying to image loader
)}!${filepath}?${WEBPACK_RESOURCE_QUERIES.metadata}`
const imageModule = `(async (props) => (await import(/* webpackMode: "eager" */ ${JSON.stringify(
imageModuleImportSource
)})).default(props))`
hasStaticMetadataFiles = true
if (type === 'favicon') {
staticImagesMetadata.icon.unshift(imageModule)
} else {
staticImagesMetadata[type].push(imageModule)
}
})
}
// Intentionally make these serial to reuse directory access cache.
await collectIconModuleIfExists('icon')
await collectIconModuleIfExists('apple')
await collectIconModuleIfExists('openGraph')
await collectIconModuleIfExists('twitter')
if (isRootLayoutOrRootPage) {
await collectIconModuleIfExists('favicon')
await collectIconModuleIfExists('manifest')
}
return hasStaticMetadataFiles ? staticImagesMetadata : null
}
export function createMetadataExportsCode(
metadata: Awaited<ReturnType<typeof createStaticMetadataFromRoute>>
) {
return metadata
? `${METADATA_TYPE}: {
icon: [${metadata.icon.join(',')}],
apple: [${metadata.apple.join(',')}],
openGraph: [${metadata.openGraph.join(',')}],
twitter: [${metadata.twitter.join(',')}],
manifest: ${metadata.manifest ? metadata.manifest : 'undefined'}
}`
: ''
}
|