feat: allow defining params on top level object when using makeUrl and makeSignedUrl methods

Author: thetutlage

adonis-typings/route.ts

@@ -203,6 +203,14 @@ declare module '@ioc:Adonis/Core/Route' {
     params?: any,
     domainParams?: any,
     prefixDomain?: boolean,
+  } & { [key: string]: any }
+
+  /**
+   * Options for making a signed url
+   */
+  export type MakeSignedUrlOptions = MakeUrlOptions & {
+    expiresIn?: string | number,
+    purpose?: string,
   }
 
   /**
@@ -244,7 +252,7 @@ declare module '@ioc:Adonis/Core/Route' {
 
     makeSignedUrl (
       routeIdentifier: string,
-      options?: MakeUrlOptions & { expiresIn?: string | number, purpose?: string },
+      options?: MakeSignedUrlOptions,
       domain?: string,
     ): string | null
 

src/Router/index.ts

@@ -15,20 +15,26 @@ import { EncryptionContract } from '@ioc:Adonis/Core/Encryption'
 
 import {
   RouteNode,
+  RouteHandler,
   MatchedRoute,
   RouteMatchers,
   RouterContract,
   MakeUrlOptions,
   RouteLookupNode,
-  RouteHandler,
+  MakeSignedUrlOptions,
 } from '@ioc:Adonis/Core/Route'
 
 import { Route } from './Route'
 import { Store } from './Store'
 import { RouteGroup } from './Group'
 import { BriskRoute } from './BriskRoute'
 import { RouteResource } from './Resource'
-import { toRoutesJSON, processPattern } from '../helpers'
+import {
+  toRoutesJSON,
+  processPattern,
+  normalizeMakeUrlOptions,
+  normalizeMakeSignedUrlOptions,
+} from '../helpers'
 
 /**
  * Router class exposes unified API to create new routes, group them or
@@ -382,7 +388,7 @@ export class Router implements RouterContract {
     /**
      * Normalizing options
      */
-    options = Object.assign({ qs: {}, params: {}, domainParams: {}, prefixDomain: true }, options)
+    options = normalizeMakeUrlOptions(options)
 
     /**
      * Processing the route pattern with dynamic segments
@@ -408,15 +414,15 @@ export class Router implements RouterContract {
    */
   public makeSignedUrl (
     routeIdentifier: string,
-    options?: MakeUrlOptions & { expiresIn?: string | number, purpose?: string },
+    options?: MakeSignedUrlOptions,
     domain?: string,
   ): string | null {
     const route = this.lookup(routeIdentifier, domain)
     if (!route) {
       return null
     }
 
-    options = Object.assign({ qs: {}, params: {}, domainParams: {}, prefixDomain: true }, options)
+    options = normalizeMakeSignedUrlOptions(options)
 
     /**
      * Making the signature from the qualified url. We do not prefix the domain when

src/helpers.ts

@@ -16,7 +16,7 @@ import { Route } from './Router/Route'
 import { RouteGroup } from './Router/Group'
 import { BriskRoute } from './Router/BriskRoute'
 import { RouteResource } from './Router/Resource'
-import { RouteJSON } from '@ioc:Adonis/Core/Route'
+import { RouteJSON, MakeUrlOptions, MakeSignedUrlOptions } from '@ioc:Adonis/Core/Route'
 import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
 const proxyCache = new QuickLru({ maxSize: 100 })
@@ -136,3 +136,39 @@ export function trustProxy (
   proxyCache.set(remoteAddress, result)
   return result
 }
+
+/**
+ * Normalizes the make url options by allowing params to appear on
+ * top level object with option to nest inside `params` property.
+ */
+export function normalizeMakeUrlOptions (options?: MakeUrlOptions): Required<MakeUrlOptions> {
+  const params = options ? (options.params ? options.params : options) : {}
+  const qs = options && options.qs ? options.qs : {}
+  const domainParams = options && options.domainParams ? options.domainParams : {}
+  const prefixDomain = options && options.prefixDomain !== undefined ? options.prefixDomain : true
+  return { params, qs, domainParams, prefixDomain }
+}
+
+/**
+ * Normalizes the make signed url options by allowing params to appear on
+ * top level object with option to nest inside `params` property.
+ */
+export function normalizeMakeSignedUrlOptions (
+  options?: MakeSignedUrlOptions,
+): Required<MakeUrlOptions> & { purpose?: string, expiresIn?: string | number } {
+  const params = options ? (options.params ? options.params : options) : {}
+  const qs = options && options.qs ? options.qs : {}
+  const domainParams = options && options.domainParams ? options.domainParams : {}
+  const prefixDomain = options && options.prefixDomain !== undefined ? options.prefixDomain : true
+  const expiresIn = options && options.expiresIn !== undefined ? options.expiresIn : undefined
+  const purpose = options && options.purpose ? options.purpose : undefined
+
+  return {
+    params,
+    qs,
+    domainParams,
+    prefixDomain,
+    expiresIn,
+    purpose,
+  }
+}

test/helpers.spec.ts

@@ -0,0 +1,78 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import test from 'japa'
+import { normalizeMakeUrlOptions, normalizeMakeSignedUrlOptions } from '../src/helpers'
+
+test.group('Helpers | normalizeMakeUrlOptions', () => {
+  test('use top level object as params', (assert) => {
+    assert.deepEqual(normalizeMakeUrlOptions({ id: 1, qs: { method: '_GET' } }), {
+      params: { id: 1, qs: { method: '_GET' } },
+      qs: { method: '_GET' },
+      domainParams: {},
+      prefixDomain: true,
+    })
+  })
+
+  test('use top params as params when defined explictly', (assert) => {
+    assert.deepEqual(normalizeMakeUrlOptions({ params: { id: 1 }, qs: { method: '_GET' } }), {
+      params: { id: 1 },
+      qs: { method: '_GET' },
+      domainParams: {},
+      prefixDomain: true,
+    })
+  })
+})
+
+test.group('Helpers | normalizeMakeSignedUrlOptions', () => {
+  test('use top level object as params', (assert) => {
+    assert.deepEqual(normalizeMakeSignedUrlOptions({ id: 1, qs: { method: '_GET' } }), {
+      params: { id: 1, qs: { method: '_GET' } },
+      qs: { method: '_GET' },
+      domainParams: {},
+      prefixDomain: true,
+      expiresIn: undefined,
+      purpose: undefined,
+    })
+  })
+
+  test('use top params as params when defined explictly', (assert) => {
+    assert.deepEqual(normalizeMakeSignedUrlOptions({ params: { id: 1 }, qs: { method: '_GET' } }), {
+      params: { id: 1 },
+      qs: { method: '_GET' },
+      domainParams: {},
+      prefixDomain: true,
+      expiresIn: undefined,
+      purpose: undefined,
+    })
+  })
+
+  test('return expiresIn value when defined', (assert) => {
+    assert.deepEqual(normalizeMakeSignedUrlOptions({ id: 1, expiresIn: '1min' }), {
+      params: { id: 1, expiresIn: '1min' },
+      qs: {},
+      domainParams: {},
+      prefixDomain: true,
+      expiresIn: '1min',
+      purpose: undefined,
+    })
+  })
+
+  test('return purpose value when defined', (assert) => {
+    assert.deepEqual(normalizeMakeSignedUrlOptions({ id: 1, purpose: 'login' }), {
+      params: { id: 1, purpose: 'login' },
+      qs: {},
+      domainParams: {},
+      prefixDomain: true,
+      expiresIn: undefined,
+      purpose: 'login',
+    })
+  })
+})
+

test/router.spec.ts

@@ -2004,13 +2004,13 @@ test.group('Brisk route', () => {
   })
 })
 
-test.group('Make url', () => {
+test.group('Router | Make url', () => {
   test('make url to a given route', (assert) => {
     const router = new Router(encryption)
     router.get('posts/:id', async function handler () {})
     router.commit()
 
-    const url = router.makeUrl('/posts/:id', { params: { id: 1 } })!
+    const url = router.makeUrl('/posts/:id', { id: 1 })!
     assert.equal(url, '/posts/1')
   })
 
@@ -2019,7 +2019,7 @@ test.group('Make url', () => {
     router.get('posts/:id', async function handler () {}).as('showPost')
     router.commit()
 
-    const url = router.makeUrl('showPost', { params: { id: 1 } })!
+    const url = router.makeUrl('showPost', { id: 1 })!
     assert.equal(url, '/posts/1')
   })
 
@@ -2028,7 +2028,7 @@ test.group('Make url', () => {
     router.get('posts/:id', 'PostsController.index').as('showPost')
     router.commit()
 
-    const url = router.makeUrl('PostsController.index', { params: { id: 1 } })!
+    const url = router.makeUrl('PostsController.index', { id: 1 })!
     assert.equal(url, '/posts/1')
   })
 
@@ -2037,7 +2037,7 @@ test.group('Make url', () => {
     router.get('posts/:id', 'PostsController.index').domain('blog.adonisjs.com')
     router.commit()
 
-    const url = router.makeUrl('PostsController.index', { params: { id: 1 } })
+    const url = router.makeUrl('PostsController.index', { id: 1 })
     assert.equal(url, '//blog.adonisjs.com/posts/1')
   })
 })
@@ -2048,7 +2048,7 @@ test.group('Make signed url', () => {
     router.get('posts/:id', async function handler () {})
     router.commit()
 
-    const url = router.makeSignedUrl('/posts/:id', { params: { id: 1 } })!
+    const url = router.makeSignedUrl('/posts/:id', { id: 1 })!
     const qs = parse(url.split('?')[1])
     assert.equal(encryption.verifier.unsign(qs.signature as string), '/posts/1')
   })
@@ -2059,7 +2059,7 @@ test.group('Make signed url', () => {
     router.get('posts/:id', async function handler () {}).as('showPost')
     router.commit()
 
-    const url = router.makeSignedUrl('showPost', { params: { id: 1 } })!
+    const url = router.makeSignedUrl('showPost', { id: 1 })!
     const qs = parse(url.split('?')[1])
     assert.equal(encryption.verifier.unsign(qs.signature as string), '/posts/1')
   })
@@ -2070,7 +2070,7 @@ test.group('Make signed url', () => {
     router.get('posts/:id', 'PostsController.index').as('showPost')
     router.commit()
 
-    const url = router.makeSignedUrl('PostsController.index', { params: { id: 1 } })!
+    const url = router.makeSignedUrl('PostsController.index', { id: 1 })!
     const qs = parse(url.split('?')[1])
     assert.equal(encryption.verifier.unsign(qs.signature as string), '/posts/1')
   })
@@ -2081,7 +2081,7 @@ test.group('Make signed url', () => {
     router.get('posts/:id', 'PostsController.index').domain('blog.adonisjs.com')
     router.commit()
 
-    const url = router.makeSignedUrl('PostsController.index', { params: { id: 1 } })!
+    const url = router.makeSignedUrl('PostsController.index', { id: 1 })!
     const qs = parse(url.split('?')[1])
 
     assert.isTrue(url.startsWith('//blog.adonisjs.com/posts/1?signature='))
@@ -2094,7 +2094,7 @@ test.group('Make signed url', () => {
     router.get('posts/:id', 'PostsController.index')
     router.commit()
 
-    const url = router.makeSignedUrl('PostsController.index', { params: { id: 1 }, expiresIn: '1m' })!
+    const url = router.makeSignedUrl('PostsController.index', { id: 1, expiresIn: '1m' })!
     const qs = parse(url.split('?')[1])
 
     assert.equal(encryption.verifier.unsign(qs.signature as string), '/posts/1')
@@ -2107,7 +2107,7 @@ test.group('Make signed url', () => {
     router.commit()
 
     const url = router.makeSignedUrl('PostsController.index', {
-      params: { id: 1 },
+      id: 1,
       qs: { page: 1 },
     })!
     const qs = parse(url.split('?')[1])
@@ -2126,7 +2126,7 @@ test.group('Make signed url', () => {
     router.commit()
 
     const url = router.makeSignedUrl('PostsController.index', {
-      params: { id: 1 },
+      id: 1,
       qs: { page: 1 },
     })!
     const qs = parse(url.split('?')[1])