Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | import { stringify } from 'qs'; import Route from './Route.js'; /** * A collection of Laravel routes. This class constitutes Ziggy's main API. */ export default class Router extends String { /** * @param {String} [name] - Route name. * @param {(String|Number|Array|Object)} [params] - Route parameters. * @param {Boolean} [absolute] - Whether to include the URL origin. * @param {Object} [config] - Ziggy configuration. */ constructor(name, params, absolute = true, config) { super(); this._config = config ?? (typeof Ziggy !== 'undefined' ? Ziggy : globalThis?.Ziggy); this._config = { ...this._config, absolute }; if (name) { if (!this._config.routes[name]) { throw new Error(`Ziggy error: route '${name}' is not in the route list.`); } this._route = new Route(name, this._config.routes[name], this._config); this._params = this._parse(params); } } /** * Get the compiled URL string for the current route and parameters. * * @example * // with 'posts.show' route 'posts/{post}' * (new Router('posts.show', 1)).toString(); // 'https://ziggy.dev/posts/1' * * @return {String} */ toString() { // Get parameters that don't correspond to any route segments to append them to the query const unhandled = Object.keys(this._params) .filter((key) => !this._route.parameterSegments.some(({ name }) => name === key)) .filter((key) => key !== '_query') .reduce((result, current) => ({ ...result, [current]: this._params[current] }), {}); return ( this._route.compile(this._params) + stringify( { ...unhandled, ...this._params['_query'] }, { addQueryPrefix: true, arrayFormat: 'indices', encodeValuesOnly: true, skipNulls: true, encoder: (value, encoder) => typeof value === 'boolean' ? Number(value) : encoder(value), }, ) ); } /** * Get the parameters, values, and metadata from the given URL. * * @param {String} [url] - The URL to inspect, defaults to the current window URL. * @return {{ name: string, params: Object, query: Object, route: Route }} */ _unresolve(url) { if (!url) { url = this._currentUrl(); } else if (this._config.absolute && url.startsWith('/')) { // If we are using absolute URLs and a relative URL // is passed, prefix the host to make it absolute url = this._location().host + url; } let matchedParams = {}; const [name, route] = Object.entries(this._config.routes).find( ([name, route]) => (matchedParams = new Route(name, route, this._config).matchesUrl(url)), ) || [undefined, undefined]; return { name, ...matchedParams, route }; } _currentUrl() { const { host, pathname, search } = this._location(); return ( (this._config.absolute ? host + pathname : pathname .replace(this._config.url.replace(/^\w*:\/\/[^/]+/, ''), '') .replace(/^\/+/, '/')) + search ); } /** * Get the name of the route matching the current window URL, or, given a route name * and parameters, check if the current window URL and parameters match that route. * * @example * // at URL https://ziggy.dev/posts/4 with 'posts.show' route 'posts/{post}' * route().current(); // 'posts.show' * route().current('posts.index'); // false * route().current('posts.show'); // true * route().current('posts.show', { post: 1 }); // false * route().current('posts.show', { post: 4 }); // true * * @param {String} [name] - Route name to check. * @param {(String|Number|Array|Object)} [params] - Route parameters. * @return {(Boolean|String|undefined)} */ current(name, params) { const { name: current, params: currentParams, query, route } = this._unresolve(); // If a name wasn't passed, return the name of the current route if (!name) return current; // Test the passed name against the current route, matching some // basic wildcards, e.g. passing `events.*` matches `events.show` const match = new RegExp(`^${name.replace(/\./g, '\\.').replace(/\*/g, '.*')}$`).test( current, ); if ([null, undefined].includes(params) || !match) return match; const routeObject = new Route(current, route, this._config); params = this._parse(params, routeObject); const routeParams = { ...currentParams, ...query }; // If the current window URL has no route parameters, and the passed parameters are empty, return true if ( Object.values(params).every((p) => !p) && !Object.values(routeParams).some((v) => v !== undefined) ) return true; const isSubset = (subset, full) => { return Object.entries(subset).every(([key, value]) => { if (Array.isArray(value) && Array.isArray(full[key])) { return value.every((v) => full[key].includes(v)); } if ( typeof value === 'object' && typeof full[key] === 'object' && value !== null && full[key] !== null ) { return isSubset(value, full[key]); } return full[key] == value; }); }; // Check that all passed parameters match their values in the current window URL // Use weak equality because all values in the current window URL will be strings return isSubset(params, routeParams); } /** * Get an object representing the current location (by default this will be * the JavaScript `window` global if it's available). * * @return {Object} */ _location() { const { host = '', pathname = '', search = '', } = typeof window !== 'undefined' ? window.location : {}; return { host: this._config.location?.host ?? host, pathname: this._config.location?.pathname ?? pathname, search: this._config.location?.search ?? search, }; } /** * Get all parameter values from the current window URL. * * @example * // at URL https://tighten.ziggy.dev/posts/4?lang=en with 'posts.show' route 'posts/{post}' and domain '{team}.ziggy.dev' * route().params; // { team: 'tighten', post: 4, lang: 'en' } * * @return {Object} */ get params() { const { params, query } = this._unresolve(); return { ...params, ...query }; } get routeParams() { return this._unresolve().params; } get queryParams() { return this._unresolve().query; } /** * Check whether the given route exists. * * @param {String} name * @return {Boolean} */ has(name) { return this._config.routes.hasOwnProperty(name); } /** * Parse Laravel-style route parameters of any type into a normalized object. * * @example * // with route parameter names 'event' and 'venue' * _parse(1); // { event: 1 } * _parse({ event: 2, venue: 3 }); // { event: 2, venue: 3 } * _parse(['Taylor', 'Matt']); // { event: 'Taylor', venue: 'Matt' } * _parse([4, { uuid: 56789, name: 'Grand Canyon' }]); // { event: 4, venue: 56789 } * * @param {(String|Number|Array|Object)} params - Route parameters. * @param {Route} route - Route instance. * @return {Object} Normalized complete route parameters. */ _parse(params = {}, route = this._route) { params ??= {}; // If `params` is a string or integer, wrap it in an array params = ['string', 'number'].includes(typeof params) ? [params] : params; // Separate segments with and without defaults, and fill in the default values const segments = route.parameterSegments.filter(({ name }) => !this._config.defaults[name]); if (Array.isArray(params)) { // If the parameters are an array they have to be in order, so we can transform them into // an object by keying them with the template segment names in the order they appear params = params.reduce( (result, current, i) => segments[i] ? { ...result, [segments[i].name]: current } : typeof current === 'object' ? { ...result, ...current } : { ...result, [current]: '' }, {}, ); } else if ( segments.length === 1 && !params[segments[0].name] && (params.hasOwnProperty(Object.values(route.bindings)[0]) || params.hasOwnProperty('id')) ) { // If there is only one template segment and `params` is an object, that object is // ambiguous—it could contain the parameter key and value, or it could be an object // representing just the value (e.g. a model); we can inspect it to find out, and // if it's just the parameter value, we can wrap it in an object with its key params = { [segments[0].name]: params }; } return { ...this._defaults(route), ...this._substituteBindings(params, route), }; } /** * Populate default parameters for the given route. * * @example * // with default parameters { locale: 'en', country: 'US' } and 'posts.show' route '{locale}/posts/{post}' * defaults(...); // { locale: 'en' } * * @param {Route} route * @return {Object} Default route parameters. */ _defaults(route) { return route.parameterSegments .filter(({ name }) => this._config.defaults[name]) .reduce( (result, { name }, i) => ({ ...result, [name]: this._config.defaults[name] }), {}, ); } /** * Substitute Laravel route model bindings in the given parameters. * * @example * _substituteBindings({ post: { id: 4, slug: 'hello-world', title: 'Hello, world!' } }, { bindings: { post: 'slug' } }); // { post: 'hello-world' } * * @param {Object} params - Route parameters. * @param {Object} route - Route definition. * @return {Object} Normalized route parameters. */ _substituteBindings(params, { bindings, parameterSegments }) { return Object.entries(params).reduce((result, [key, value]) => { // If the value isn't an object, or if the key isn't a named route parameter, // there's nothing to substitute so we return it as-is if ( !value || typeof value !== 'object' || Array.isArray(value) || !parameterSegments.some(({ name }) => name === key) ) { return { ...result, [key]: value }; } if (!value.hasOwnProperty(bindings[key])) { if (value.hasOwnProperty('id')) { // As a fallback, we still accept an 'id' key not explicitly registered as a binding bindings[key] = 'id'; } else { throw new Error( `Ziggy error: object passed as '${key}' parameter is missing route model binding key '${bindings[key]}'.`, ); } } return { ...result, [key]: value[bindings[key]] }; }, {}); } valueOf() { return this.toString(); } } |