-
Notifications
You must be signed in to change notification settings - Fork 322
Expand file tree
/
Copy pathimage.ts
More file actions
294 lines (246 loc) · 9.47 KB
/
image.ts
File metadata and controls
294 lines (246 loc) · 9.47 KB
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
import { defu } from 'defu'
import { hasProtocol, parseURL, joinURL, withLeadingSlash } from 'ufo'
import { imageMeta } from './utils/meta'
import { checkDensities, parseDensities, parseSize, parseSizes } from './utils'
import { prerenderStaticImages } from './utils/prerender'
import type { ImageOptions, ImageSizesOptions, CreateImageOptions, ResolvedImage, ImageCTX, $Img, ImageSizes, ImageSizesVariant, ConfiguredImageProviders } from '@nuxt/image'
export function createImage(globalOptions: CreateImageOptions) {
const ctx: ImageCTX = {
options: globalOptions,
}
const getImage: $Img['getImage'] = (input: string, options = {}) => {
const image = resolveImage(ctx, input, options)
// Prerender static images
if (import.meta.server && import.meta.prerender && globalOptions.event) {
prerenderStaticImages(image.url, undefined, globalOptions.event)
}
return image
}
const $img = ((input, modifiers, options) => getImage(input, defu({ modifiers }, options)).url) as $Img
for (const presetName in globalOptions.presets) {
$img[presetName] = ((source, modifiers, options) =>
$img(source, modifiers, { ...globalOptions.presets[presetName], ...options })) as $Img[string]
}
$img.options = globalOptions
$img.getImage = getImage
$img.getMeta = ((input: string, options?: ImageOptions) => getMeta(ctx, input, options)) as $Img['getMeta']
$img.getSizes = ((input: string, options: ImageSizesOptions) => getSizes(ctx, input, options)) as $Img['getSizes']
ctx.$img = $img as $Img
return $img
}
async function getMeta(ctx: ImageCTX, input: string, options?: ImageOptions) {
const image = resolveImage(ctx, input, { ...options })
if (typeof image.getMeta === 'function') {
return await image.getMeta()
}
else {
return await imageMeta(ctx, image.url)
}
}
function resolveImage(ctx: ImageCTX, input: string, options: ImageOptions): ResolvedImage {
if (input && typeof input !== 'string') {
throw new TypeError(`input must be a string (received ${typeof input}: ${JSON.stringify(input)})`)
}
if (!input || input.startsWith('data:')) {
return {
url: input,
}
}
const { setup, defaults } = getProvider(ctx, options.provider as keyof ConfiguredImageProviders || ctx.options.provider)
const provider = setup()
const preset = getPreset(ctx, options.preset)
// Normalize input with leading slash
input = hasProtocol(input) ? input : withLeadingSlash(input)
// Resolve alias if provider is not ipx
if (!provider.supportsAlias) {
for (const base in ctx.options.alias) {
if (input.startsWith(base)) {
const alias = ctx.options.alias[base]
if (alias) {
input = joinURL(alias, input.slice(base.length))
}
}
}
}
// Externalize remote images if domain does not match with `domains`
if (provider.validateDomains && hasProtocol(input)) {
const inputHost = parseURL(input).host
// Domains are normalized to hostname in module
if (!ctx.options.domains.find(d => d === inputHost)) {
return {
url: input,
}
}
}
const _options = defu(options, preset, defaults as Partial<ImageOptions>)
// Determine the final format (might come from modifiers, defaults, or global config)
const finalFormat = (_options.modifiers?.format as string | undefined) || ctx.options.format?.[0]
if (!_options.modifiers?.quality && typeof ctx.options.quality === 'object') {
const qualityMap = ctx.options.quality as Record<string, number>
const mappedQuality = (finalFormat && qualityMap[finalFormat]) ?? qualityMap.default ?? Object.values(qualityMap)[0]
if (typeof mappedQuality === 'number') {
_options.modifiers = { ..._options.modifiers, quality: mappedQuality }
}
}
// Resolve quality: if it's an object (quality map), resolve to number based on format
if (_options.modifiers?.quality && typeof _options.modifiers.quality === 'object') {
const qualityMap = _options.modifiers.quality as Record<string, number>
_options.modifiers.quality = (finalFormat && qualityMap[finalFormat]) || qualityMap.default
}
const resolvedOptions = {
..._options,
modifiers: {
..._options.modifiers,
width: _options.modifiers?.width ? parseSize(_options.modifiers.width) : undefined,
height: _options.modifiers?.height ? parseSize(_options.modifiers.height) : undefined,
},
}
const image = provider.getImage(input, resolvedOptions, ctx)
image.format ||= resolvedOptions.modifiers.format || ''
return image
}
function getProvider(ctx: ImageCTX, name: keyof ConfiguredImageProviders) {
const provider = ctx.options.providers[name]
if (!provider) {
throw new Error('Unknown provider: ' + name)
}
return provider
}
function getPreset(ctx: ImageCTX, name?: string): ImageOptions {
if (!name) {
return {}
}
if (!ctx.options.presets[name]) {
throw new Error('Unknown preset: ' + name)
}
return ctx.options.presets[name]
}
function getSizes(ctx: ImageCTX, input: string, opts: ImageSizesOptions): ImageSizes {
// Merge preset options so preset-provided sizes/densities are respected
const preset = getPreset(ctx, opts.preset)
const merged = defu(opts, preset)
const width = parseSize(merged.modifiers?.width)
const height = parseSize(merged.modifiers?.height)
const sizes = merged.sizes ? parseSizes(merged.sizes) : {}
const _densities = merged.densities?.trim()
const densities = _densities ? parseDensities(_densities) : ctx.options.densities
checkDensities(densities)
const hwRatio = (width && height) ? height / width : 0
const sizeVariants = []
const srcsetVariants = []
if (Object.keys(sizes).length >= 1) {
// 'sizes path'
for (const key in sizes) {
const variant = getSizesVariant(key, String(sizes[key]), height, hwRatio, ctx)
if (variant === undefined) {
continue
}
// add size variant with 'media'
sizeVariants.push({
size: variant.size,
screenMaxWidth: variant.screenMaxWidth,
media: `(max-width: ${variant.screenMaxWidth}px)`,
})
// add srcset variants for all densities (for current 'size' processed)
for (const density of densities) {
srcsetVariants.push({
width: variant._cWidth * density,
src: getVariantSrc(ctx, input, opts, variant, density),
})
}
}
finaliseSizeVariants(sizeVariants)
}
else {
// 'densities path'
for (const density of densities) {
const key = Object.keys(sizes)[0]
let variant = key ? getSizesVariant(key, String(sizes[key]), height, hwRatio, ctx) : undefined
// unable to resolve variant, fallback to default modifiers
if (variant === undefined) {
variant = {
size: '',
screenMaxWidth: 0,
_cWidth: opts.modifiers?.width as number,
_cHeight: opts.modifiers?.height as number,
}
}
srcsetVariants.push({
width: density,
src: getVariantSrc(ctx, input, opts, variant, density),
})
}
}
finaliseSrcsetVariants(srcsetVariants)
// use last (:= largest) srcset variant as the image `src`
const defaultVariant = srcsetVariants[srcsetVariants.length - 1]
const sizesVal = sizeVariants.length ? sizeVariants.map(v => `${v.media ? v.media + ' ' : ''}${v.size}`).join(', ') : undefined
const suffix = sizesVal ? 'w' : 'x'
const srcsetVal = srcsetVariants.map(v => `${v.src} ${v.width}${suffix}`).join(', ')
return {
sizes: sizesVal,
srcset: srcsetVal,
src: defaultVariant?.src,
}
}
function getSizesVariant(key: string, size: string, height: number | undefined, hwRatio: number, ctx: ImageCTX): ImageSizesVariant | undefined {
const screenMaxWidth = (ctx.options.screens && ctx.options.screens[key]) || Number.parseInt(key)
const isFluid = size.endsWith('vw')
if (!isFluid && /^\d+$/.test(size)) {
size = size + 'px'
}
if (!isFluid && !size.endsWith('px')) {
return undefined
}
let _cWidth = Number.parseInt(size)
if (!screenMaxWidth || !_cWidth) {
return undefined
}
if (isFluid) {
_cWidth = Math.round((_cWidth / 100) * screenMaxWidth)
}
const _cHeight = hwRatio ? Math.round(_cWidth * hwRatio) : height
return {
size,
screenMaxWidth,
_cWidth,
_cHeight,
}
}
function getVariantSrc(ctx: ImageCTX, input: string, opts: ImageSizesOptions, variant: ImageSizesVariant, density: number) {
return ctx.$img!(input,
{
...opts.modifiers,
width: variant._cWidth ? variant._cWidth * density : undefined,
height: variant._cHeight ? variant._cHeight * density : undefined,
},
opts)
}
function finaliseSizeVariants(sizeVariants: any[]) {
sizeVariants.sort((v1, v2) => v1.screenMaxWidth - v2.screenMaxWidth)
// de-duplicate size variants (by key `media`)
let previousMedia = null
for (let i = sizeVariants.length - 1; i >= 0; i--) {
const sizeVariant = sizeVariants[i]
if (sizeVariant.media === previousMedia) {
sizeVariants.splice(i, 1)
}
previousMedia = sizeVariant.media
}
for (let i = 0; i < sizeVariants.length; i++) {
sizeVariants[i].media = sizeVariants[i + 1]?.media || ''
}
}
function finaliseSrcsetVariants(srcsetVariants: any[]) {
// sort by width
srcsetVariants.sort((v1, v2) => v1.width - v2.width)
// de-duplicate srcset variants (by key `width`)
let previousWidth = null
for (let i = srcsetVariants.length - 1; i >= 0; i--) {
const sizeVariant = srcsetVariants[i]
if (sizeVariant.width === previousWidth) {
srcsetVariants.splice(i, 1)
}
previousWidth = sizeVariant.width
}
}