refactor: deprecate hash.hash in favor of hash.make

adonis-typings/hash.ts

@@ -24,6 +24,7 @@ declare module '@ioc:Adonis/Core/Hash' {
      * Hash plain text value using the default mapping
      */
     hash (value: string): Promise<string>
+    make (value: string): Promise<string>
 
     /**
      * Check the hash against the current config to find it needs
@@ -127,6 +128,7 @@ declare module '@ioc:Adonis/Core/Hash' {
      * Hash plain text value using the default mapping
      */
     hash (value: string): ReturnType<HashDriverContract['hash']>
+    make (value: string): ReturnType<HashDriverContract['make']>
 
     /**
      * Verify plain value against the hashed value to find if it's

src/Drivers/Argon.ts

@@ -41,11 +41,19 @@ export class Argon implements ArgonContract {
   constructor (private config: ArgonConfig) {
   }
 
+  /**
+   * Alias for [[this.make]]
+   */
+  public hash (value: string): Promise<string> {
+    process.emitWarning('DeprecationWarning', 'Hash.hash() is deprecated. Use Hash.make() instead')
+    return this.make(value)
+  }
+
   /**
    * Hash a value using argon algorithm. The options can be used to override
    * default settings.
    */
-  public hash (value: string): Promise<string> {
+  public make (value: string) {
     return argon2.hash(value, this.config)
   }
 

src/Drivers/Bcrypt.ts

@@ -26,9 +26,17 @@ export class Bcrypt implements BcryptContract {
   }
 
   /**
-   * Returns hash for a given value
+   * Alias for [[this.make]]
    */
   public hash (value: string): Promise<string> {
+    process.emitWarning('DeprecationWarning', 'Hash.hash() is deprecated. Use Hash.make() instead')
+    return this.make(value)
+  }
+
+  /**
+   * Returns hash for a given value
+   */
+  public make (value: string) {
     return bcrypt.hash(value, this.config)
   }
 

src/Hash.ts

@@ -85,12 +85,19 @@ export class Hash <Config extends HashConfig> extends Manager<
   }
 
   /**
-   * Hash value using the default driver
+   * Alias for [[this.make]]
    */
   public hash (value: string): never | any {
     return (this.use() as HashDriverContract).hash(value)
   }
 
+  /**
+   * Hash value using the default driver
+   */
+  public make (value: string) {
+    return (this.use() as HashDriverContract).make(value)
+  }
+
   /**
    * Verify value using the default driver
    */

test/argon2.spec.ts

@@ -42,7 +42,7 @@ test.group('Argon', () => {
       saltSize: 16,
     })
 
-    const hashed = await argon.hash('hello-world')
+    const hashed = await argon.make('hello-world')
     let matches = await argon.verify(hashed, 'hello-world')
     assert.isTrue(matches)
 
@@ -69,7 +69,7 @@ test.group('Argon', () => {
       saltSize: 16,
     })
 
-    const hashed = await argon.hash('hello-world')
+    const hashed = await argon.make('hello-world')
     assert.isTrue(argon1.needsReHash(hashed))
     assert.isFalse(argon.needsReHash(hashed))
   })
@@ -84,7 +84,7 @@ test.group('Argon', () => {
       saltSize: 16,
     })
 
-    const hashed = await argon.hash('hello-world')
+    const hashed = await argon.make('hello-world')
     assert.isTrue(argon.needsReHash(hashed.replace('$v=19', '$v=18')))
   })
 
@@ -107,7 +107,7 @@ test.group('Argon', () => {
       saltSize: 16,
     })
 
-    const hashed = await argon.hash('hello-world')
+    const hashed = await argon.make('hello-world')
     assert.isTrue(argon1.needsReHash(hashed))
     assert.isFalse(argon.needsReHash(hashed))
   })

test/bcrypt.spec.ts

@@ -15,7 +15,7 @@ import { Bcrypt } from '../src/Drivers/Bcrypt'
 test.group('Bcrypt', () => {
   test('hash value using defaults', async (assert) => {
     const bcrypt = new Bcrypt({ rounds: 10, driver: 'bcrypt' })
-    const hashed = await bcrypt.hash('hello-world')
+    const hashed = await bcrypt.make('hello-world')
     const values = phc.deserialize(hashed)
 
     assert.equal(values.id, 'bcrypt')
@@ -26,7 +26,7 @@ test.group('Bcrypt', () => {
 
   test('verify hashed value', async (assert) => {
     const bcrypt = new Bcrypt({ rounds: 10, driver: 'bcrypt' })
-    const hashed = await bcrypt.hash('hello-world')
+    const hashed = await bcrypt.make('hello-world')
 
     let matched = await bcrypt.verify(hashed, 'hello-world')
     assert.isTrue(matched)
@@ -38,15 +38,15 @@ test.group('Bcrypt', () => {
   test('return true for needsRehash when version mismatch', async (assert) => {
     const bcrypt = new Bcrypt({ rounds: 10, driver: 'bcrypt' })
 
-    const hashed = await bcrypt.hash('hello-world')
+    const hashed = await bcrypt.make('hello-world')
     assert.isTrue(bcrypt.needsReHash(hashed.replace('$v=98', '$v=20')))
   })
 
   test('return true for needsRehash when one of the params are different', async (assert) => {
     const bcrypt = new Bcrypt({ rounds: 10, driver: 'bcrypt' })
     const bcrypt2 = new Bcrypt({ rounds: 11, driver: 'bcrypt' })
 
-    const hashed = await bcrypt.hash('hello-world')
+    const hashed = await bcrypt.make('hello-world')
     assert.isTrue(bcrypt2.needsReHash(hashed))
     assert.isFalse(bcrypt.needsReHash(hashed))
   })

test/hash.spec.ts

@@ -33,20 +33,20 @@ const config = {
 test.group('Hash', () => {
   test('hash value using the default driver', async (assert) => {
     const hash = new Hash({}, config as any)
-    const hashedValue = await hash.hash('hello-world')
+    const hashedValue = await hash.make('hello-world')
     assert.match(hashedValue, /^\$bcrypt/)
   })
 
   test('verify value using the default driver', async (assert) => {
     const hash = new Hash({}, config as any)
-    const hashedValue = await hash.hash('hello-world')
+    const hashedValue = await hash.make('hello-world')
     const isSame = await hash.verify(hashedValue, 'hello-world')
     assert.isTrue(isSame)
   })
 
   test('find if value needsReHash for the default driver', async (assert) => {
     const hash = new Hash({}, config as any)
-    const hashedValue = await hash.hash('hello-world')
+    const hashedValue = await hash.make('hello-world')
     const needsReHash = hash.needsReHash(hashedValue)
     assert.isFalse(needsReHash)
   })
@@ -74,6 +74,10 @@ test.group('Hash', () => {
         return 'foo'
       }
 
+      public async make (): Promise<string> {
+        return 'foo'
+      }
+
       public async verify (): Promise<boolean> {
         return true
       }