Nuxt/packages/vue-app/template/utils.js

576 lines
15 KiB
JavaScript
Raw Normal View History

2017-05-04 07:57:10 +00:00
import Vue from 'vue'
2016-11-07 01:34:58 +00:00
2017-04-14 14:31:14 +00:00
const noopData = () => ({})
// window.{{globals.loadedCallback}} hook
2017-07-10 22:53:06 +00:00
// Useful for jsdom testing or plugins (https://github.com/tmpvar/jsdom#dealing-with-asynchronous-script-loading)
2018-11-08 09:15:56 +00:00
if (process.client) {
window.<%= globals.readyCallback %>Cbs = []
window.<%= globals.readyCallback %> = (cb) => {
window.<%= globals.readyCallback %>Cbs.push(cb)
2017-07-10 22:53:06 +00:00
}
}
export function empty() {}
export function globalHandleError(error) {
if (Vue.config.errorHandler) {
Vue.config.errorHandler(error)
}
}
export function interopDefault(promise) {
2018-10-24 13:46:06 +00:00
return promise.then(m => m.default || m)
}
export function applyAsyncData(Component, asyncData) {
2017-04-14 14:31:14 +00:00
const ComponentData = Component.options.data || noopData
// Prevent calling this method for each request on SSR context
2017-08-29 18:53:50 +00:00
if (!asyncData && Component.options.hasAsyncData) {
return
}
Component.options.hasAsyncData = true
2017-04-14 14:31:14 +00:00
Component.options.data = function () {
2018-10-24 13:46:06 +00:00
const data = ComponentData.call(this)
2017-08-29 18:53:50 +00:00
if (this.$ssrContext) {
asyncData = this.$ssrContext.asyncData[Component.cid]
}
2017-04-14 14:31:14 +00:00
return { ...data, ...asyncData }
}
if (Component._Ctor && Component._Ctor.options) {
Component._Ctor.options.data = Component.options.data
}
}
export function sanitizeComponent(Component) {
// If Component already sanitized
if (Component.options && Component._Ctor === Component) {
return Component
}
2017-05-04 07:57:10 +00:00
if (!Component.options) {
Component = Vue.extend(Component) // fix issue #6
Component._Ctor = Component
} else {
Component._Ctor = Component
Component.extendOptions = Component.options
}
// For debugging purpose
if (!Component.options.name && Component.options.__file) {
Component.options.name = Component.options.__file
}
return Component
}
2018-01-24 06:33:27 +00:00
export function getMatchedComponents(route, matches = false) {
2018-08-15 13:23:03 +00:00
return Array.prototype.concat.apply([], route.matched.map((m, index) => {
return Object.keys(m.components).map((key) => {
2018-01-24 06:33:27 +00:00
matches && matches.push(index)
2016-11-07 01:34:58 +00:00
return m.components[key]
})
}))
}
2018-01-24 06:33:27 +00:00
export function getMatchedComponentsInstances(route, matches = false) {
2018-08-15 13:23:03 +00:00
return Array.prototype.concat.apply([], route.matched.map((m, index) => {
return Object.keys(m.instances).map((key) => {
2018-01-24 06:33:27 +00:00
matches && matches.push(index)
2016-11-22 23:27:07 +00:00
return m.instances[key]
})
}))
}
export function flatMapComponents(route, fn) {
2018-08-15 13:23:03 +00:00
return Array.prototype.concat.apply([], route.matched.map((m, index) => {
return Object.keys(m.components).reduce((promises, key) => {
if (m.components[key]) {
promises.push(fn(m.components[key], m.instances[key], m, key, index))
} else {
delete m.components[key]
}
return promises
}, [])
2016-11-07 01:34:58 +00:00
}))
}
export function resolveRouteComponents(route) {
return Promise.all(
flatMapComponents(route, async (Component, _, match, key) => {
// If component is a function, resolve it
if (typeof Component === 'function' && !Component.options) {
Component = await Component()
}
2018-10-24 13:46:06 +00:00
match.components[key] = sanitizeComponent(Component)
return match.components[key]
})
)
}
export async function getRouteData(route) {
// Make sure the components are resolved (code-splitting)
await resolveRouteComponents(route)
// Send back a copy of route with meta based on Component definition
return {
...route,
meta: getMatchedComponents(route).map((Component, index) => {
return { ...Component.options.meta, ...(route.matched[index] || {}).meta }
})
2016-11-10 23:01:36 +00:00
}
}
export async function setContext(app, context) {
// If context not defined, create it
if (!app.context) {
app.context = {
isStatic: process.static,
isDev: <%= isDev %>,
isHMR: false,
app,
<%= (store ? 'store: app.store,' : '') %>
payload: context.payload,
error: context.error,
base: '<%= router.base %>',
2018-10-24 13:46:06 +00:00
env: <%= JSON.stringify(env) %><%= isTest ? '// eslint-disable-line' : '' %>
}
// Only set once
if (context.req) {
app.context.req = context.req
}
if (context.res) {
app.context.res = context.res
}
if (context.ssrContext) {
app.context.ssrContext = context.ssrContext
}
2018-08-15 13:23:03 +00:00
app.context.redirect = (status, path, query) => {
if (!status) {
return
}
app.context._redirected = true
// if only 1 or 2 arguments: redirect('/') or redirect('/', { foo: 'bar' })
2017-12-21 04:55:32 +00:00
let pathType = typeof path
if (typeof status !== 'number' && (pathType === 'undefined' || pathType === 'object')) {
query = path || {}
path = status
2017-12-21 04:55:32 +00:00
pathType = typeof path
status = 302
}
2017-12-21 04:55:32 +00:00
if (pathType === 'object') {
path = app.router.resolve(path).href
}
// "/absolute/route", "./relative/route" or "../relative/route"
if (/(^[.]{1,2}\/)|(^\/(?!\/))/.test(path)) {
2017-11-28 09:10:20 +00:00
app.context.next({
path: path,
query: query,
status: status
})
} else {
path = formatUrl(path, query)
if (process.server) {
app.context.next({
path: path,
status: status
})
2017-11-28 09:10:20 +00:00
}
2018-11-08 09:15:56 +00:00
if (process.client) {
// https://developer.mozilla.org/en-US/docs/Web/API/Location/replace
window.location.replace(path)
// Throw a redirect error
throw new Error('ERR_REDIRECT')
2017-11-28 09:10:20 +00:00
}
}
}
if (process.server) {
app.context.beforeNuxtRender = fn => context.beforeRenderFns.push(fn)
}
2018-11-08 09:15:56 +00:00
if (process.client) {
app.context.nuxtState = window.<%= globals.context %>
}
2017-08-31 12:46:06 +00:00
}
// Dynamic keys
app.context.next = context.next
app.context._redirected = false
app.context._errored = false
app.context.isHMR = !!context.isHMR
2018-08-15 13:23:03 +00:00
if (context.route) {
app.context.route = await getRouteData(context.route)
}
app.context.params = app.context.route.params || {}
app.context.query = app.context.route.query || {}
2018-08-15 13:23:03 +00:00
if (context.from) {
app.context.from = await getRouteData(context.from)
}
2016-11-07 01:34:58 +00:00
}
export function middlewareSeries(promises, appContext) {
if (!promises.length || appContext._redirected || appContext._errored) {
2017-02-03 14:09:27 +00:00
return Promise.resolve()
}
2017-10-24 21:19:14 +00:00
return promisify(promises[0], appContext)
2018-10-24 13:46:06 +00:00
.then(() => {
return middlewareSeries(promises.slice(1), appContext)
})
2017-02-03 14:09:27 +00:00
}
export function promisify(fn, context) {
let promise
if (fn.length === 2) {
<% if (isDev) { %>
console.warn('Callback-based asyncData, fetch or middleware calls are deprecated. ' +
'Please switch to promises or async/await syntax')
<% } %>
// fn(context, callback)
promise = new Promise((resolve) => {
fn(context, function (err, data) {
if (err) {
context.error(err)
}
data = data || {}
resolve(data)
})
})
} else {
promise = fn(context)
}
2017-04-06 09:18:27 +00:00
if (!promise || (!(promise instanceof Promise) && (typeof promise.then !== 'function'))) {
promise = Promise.resolve(promise)
}
return promise
}
2016-11-07 01:34:58 +00:00
// Imported from vue-router
export function getLocation(base, mode) {
2018-10-24 13:46:06 +00:00
let path = window.location.pathname
if (mode === 'hash') {
return window.location.hash.replace(/^#\//, '')
}
2016-11-07 01:34:58 +00:00
if (base && path.indexOf(base) === 0) {
path = path.slice(base.length)
}
return decodeURI(path || '/') + window.location.search + window.location.hash
2016-11-07 01:34:58 +00:00
}
2016-11-10 23:01:36 +00:00
export function urlJoin() {
2018-08-15 13:23:03 +00:00
return Array.prototype.slice.call(arguments).join('/').replace(/\/+/g, '/')
2016-11-10 23:01:36 +00:00
}
2016-12-16 16:45:05 +00:00
// Imported from path-to-regexp
/**
* Compile a string to a template function for the path.
*
* @param {string} str
* @param {Object=} options
* @return {!function(Object=, Object=)}
*/
export function compile(str, options) {
2016-12-16 16:45:05 +00:00
return tokensToFunction(parse(str, options))
}
2017-11-06 17:30:37 +00:00
export function getQueryDiff(toQuery, fromQuery) {
const diff = {}
const queries = { ...toQuery, ...fromQuery }
for (const k in queries) {
if (String(toQuery[k]) !== String(fromQuery[k])) {
diff[k] = true
}
}
return diff
}
export function normalizeError(err) {
let message
if (!(err.message || typeof err === 'string')) {
try {
message = JSON.stringify(err, null, 2)
} catch (e) {
message = `[${err.constructor.name}]`
}
} else {
message = err.message || err
}
return {
...err,
message: message,
statusCode: (err.statusCode || err.status || (err.response && err.response.status) || 500)
}
}
2016-12-16 16:45:05 +00:00
/**
* The main path matching regexp utility.
*
* @type {RegExp}
*/
const PATH_REGEXP = new RegExp([
// Match escaped characters that would otherwise appear in future matches.
// This allows the user to escape special characters that won't transform.
'(\\\\.)',
// Match Express-style parameters and un-named parameters with a prefix
// and optional suffixes. Matches appear as:
//
// "/:test(\\d+)?" => ["/", "test", "\d+", undefined, "?", undefined]
// "/route(\\d+)" => [undefined, undefined, undefined, "\d+", undefined, undefined]
// "/*" => ["/", undefined, undefined, undefined, undefined, "*"]
'([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))'
].join('|'), 'g')
/**
* Parse a string for the raw tokens.
*
* @param {string} str
* @param {Object=} options
* @return {!Array}
*/
function parse(str, options) {
2018-10-24 13:46:06 +00:00
const tokens = []
let key = 0
let index = 0
let path = ''
const defaultDelimiter = (options && options.delimiter) || '/'
let res
2016-12-16 16:45:05 +00:00
while ((res = PATH_REGEXP.exec(str)) != null) {
2018-10-24 13:46:06 +00:00
const m = res[0]
const escaped = res[1]
const offset = res.index
2016-12-16 16:45:05 +00:00
path += str.slice(index, offset)
index = offset + m.length
// Ignore already escaped sequences.
if (escaped) {
path += escaped[1]
continue
}
2018-10-24 13:46:06 +00:00
const next = str[index]
const prefix = res[2]
const name = res[3]
const capture = res[4]
const group = res[5]
const modifier = res[6]
const asterisk = res[7]
2016-12-16 16:45:05 +00:00
// Push the current path onto the tokens.
if (path) {
tokens.push(path)
path = ''
}
2018-10-24 13:46:06 +00:00
const partial = prefix != null && next != null && next !== prefix
const repeat = modifier === '+' || modifier === '*'
const optional = modifier === '?' || modifier === '*'
const delimiter = res[2] || defaultDelimiter
const pattern = capture || group
2016-12-16 16:45:05 +00:00
tokens.push({
name: name || key++,
prefix: prefix || '',
delimiter: delimiter,
optional: optional,
repeat: repeat,
partial: partial,
asterisk: !!asterisk,
pattern: pattern ? escapeGroup(pattern) : (asterisk ? '.*' : '[^' + escapeString(delimiter) + ']+?')
})
}
// Match any characters still remaining.
if (index < str.length) {
path += str.substr(index)
}
// If the path exists, push it onto the end.
if (path) {
tokens.push(path)
}
return tokens
}
/**
* Prettier encoding of URI path segments.
*
* @param {string}
* @return {string}
*/
function encodeURIComponentPretty(str) {
2018-10-24 13:46:06 +00:00
return encodeURI(str).replace(/[/?#]/g, (c) => {
2016-12-16 16:45:05 +00:00
return '%' + c.charCodeAt(0).toString(16).toUpperCase()
})
}
/**
* Encode the asterisk parameter. Similar to `pretty`, but allows slashes.
*
* @param {string}
* @return {string}
*/
function encodeAsterisk(str) {
2018-08-15 13:23:03 +00:00
return encodeURI(str).replace(/[?#]/g, (c) => {
2016-12-16 16:45:05 +00:00
return '%' + c.charCodeAt(0).toString(16).toUpperCase()
})
}
/**
* Expose a method for transforming tokens into the path function.
*/
function tokensToFunction(tokens) {
2016-12-16 16:45:05 +00:00
// Compile all the tokens into regexps.
2018-10-24 13:46:06 +00:00
const matches = new Array(tokens.length)
2016-12-16 16:45:05 +00:00
// Compile all the patterns before compilation.
2018-10-24 13:46:06 +00:00
for (let i = 0; i < tokens.length; i++) {
2016-12-16 16:45:05 +00:00
if (typeof tokens[i] === 'object') {
matches[i] = new RegExp('^(?:' + tokens[i].pattern + ')$')
}
}
2018-10-24 13:46:06 +00:00
return function (obj, opts) {
let path = ''
const data = obj || {}
const options = opts || {}
const encode = options.pretty ? encodeURIComponentPretty : encodeURIComponent
2016-12-16 16:45:05 +00:00
2018-10-24 13:46:06 +00:00
for (let i = 0; i < tokens.length; i++) {
const token = tokens[i]
2016-12-16 16:45:05 +00:00
if (typeof token === 'string') {
path += token
continue
}
const value = data[token.name || 'pathMatch']
2018-10-24 13:46:06 +00:00
let segment
2016-12-16 16:45:05 +00:00
if (value == null) {
if (token.optional) {
// Prepend partial segment prefixes.
if (token.partial) {
path += token.prefix
}
continue
} else {
throw new TypeError('Expected "' + token.name + '" to be defined')
}
}
if (Array.isArray(value)) {
if (!token.repeat) {
throw new TypeError('Expected "' + token.name + '" to not repeat, but received `' + JSON.stringify(value) + '`')
}
if (value.length === 0) {
if (token.optional) {
continue
} else {
throw new TypeError('Expected "' + token.name + '" to not be empty')
}
}
2018-10-24 13:46:06 +00:00
for (let j = 0; j < value.length; j++) {
2016-12-16 16:45:05 +00:00
segment = encode(value[j])
if (!matches[i].test(segment)) {
throw new TypeError('Expected all "' + token.name + '" to match "' + token.pattern + '", but received `' + JSON.stringify(segment) + '`')
}
path += (j === 0 ? token.prefix : token.delimiter) + segment
}
continue
}
segment = token.asterisk ? encodeAsterisk(value) : encode(value)
if (!matches[i].test(segment)) {
throw new TypeError('Expected "' + token.name + '" to match "' + token.pattern + '", but received "' + segment + '"')
}
path += token.prefix + segment
}
return path
}
}
/**
* Escape a regular expression string.
*
* @param {string} str
* @return {string}
*/
function escapeString(str) {
2018-10-24 13:46:06 +00:00
return str.replace(/([.+*?=^!:${}()[\]|/\\])/g, '\\$1')
2016-12-16 16:45:05 +00:00
}
/**
* Escape the capturing group by escaping special characters and meaning.
*
* @param {string} group
* @return {string}
*/
function escapeGroup(group) {
2018-10-24 13:46:06 +00:00
return group.replace(/([=!:$/()])/g, '\\$1')
2016-12-16 16:45:05 +00:00
}
2017-11-28 09:10:20 +00:00
/**
* Format given url, append query to url query string
*
* @param {string} url
* @param {string} query
* @return {string}
*/
2018-10-24 13:46:06 +00:00
function formatUrl(url, query) {
2017-11-28 09:10:20 +00:00
let protocol
2018-10-24 13:46:06 +00:00
const index = url.indexOf('://')
2017-11-28 09:10:20 +00:00
if (index !== -1) {
protocol = url.substring(0, index)
url = url.substring(index + 3)
} else if (url.startsWith('//')) {
2017-11-28 09:10:20 +00:00
url = url.substring(2)
}
let parts = url.split('/')
let result = (protocol ? protocol + '://' : '//') + parts.shift()
let path = parts.filter(Boolean).join('/')
let hash
parts = path.split('#')
if (parts.length === 2) {
path = parts[0]
hash = parts[1]
}
result += path ? '/' + path : ''
if (query && JSON.stringify(query) !== '{}') {
result += (url.split('?').length === 2 ? '&' : '?') + formatQuery(query)
}
result += hash ? '#' + hash : ''
return result
}
/**
* Transform data object to query string
*
* @param {object} query
* @return {string}
*/
2018-10-24 13:46:06 +00:00
function formatQuery(query) {
return Object.keys(query).sort().map((key) => {
2018-10-24 13:46:06 +00:00
const val = query[key]
2017-11-28 09:10:20 +00:00
if (val == null) {
return ''
}
if (Array.isArray(val)) {
return val.slice().map(val2 => [key, '=', val2].join('')).join('&')
}
return key + '=' + val
}).filter(Boolean).join('&')
}