add typings for dialablePhoneNumber hook, add libphonenumber-js as a dependency

Author: Jan Lohage

package.json

@@ -79,6 +79,7 @@
     "graphql": "^14.0.2",
     "http-shutdown": "^1.2.0",
     "istanbul": "^1.1.0-alpha.1",
+    "libphonenumber-js": "^1.6.8",
     "mkdirp": "^0.5.1",
     "mocha": "^5.0.1",
     "mongodb": "^3.1.0-beta4",

types/index.d.ts

@@ -3,6 +3,7 @@
 import { Hook, HookContext, Params, Query, Paginated, Application } from '@feathersjs/feathers';
 import * as ajv from 'ajv';
 import { GraphQLSchema, parse } from 'graphql';
+import * as libphonenumberjs from 'libphonenumber-js';
 
 export type HookType = 'before' | 'after' | 'error';
 export type MethodName = 'find' | 'create' | 'get' | 'update' | 'patch' | 'remove';
@@ -120,6 +121,18 @@ export function deleteByDot(object: any, path: string): void;
  */
 export function dePopulate(): Hook;
 
+// todo: dialablePhoneNumber docs
+/**
+ * {@link https://feathers-plus.github.io/v1/feathers-hooks-common/index.html#DialablePhoneNumber}
+ */
+export function dialablePhoneNumber(
+    libphonenumberJs: typeof libphonenumberjs,
+    defaultCountry?: libphonenumberjs.CountryCode,
+    phoneField?: string,
+    dialableField?: string,
+    countryField?: string
+): Hook;
+
 /**
  * Prevents null from being used as an id in patch and remove service methods.
  * {@link https://feathers-plus.github.io/v1/feathers-hooks-common/index.html#DisableMultiItemChange}

types/tests.ts

@@ -14,6 +14,7 @@ import {
     debug,
     deleteByDot,
     dePopulate,
+    dialablePhoneNumber,
     disableMultiItemChange,
     disableMultiItemCreate,
     disablePagination,
@@ -66,6 +67,7 @@ import {
 } from 'feathers-hooks-common';
 import ajv = require('ajv');
 import { parse } from 'graphql';
+import * as libphonenumberjs from 'libphonenumber-js';
 
 const context1: HookContext = {
     type: 'before',
@@ -139,6 +141,9 @@ deleteByDot({}, 'abc.def');
 // $ExpectType Hook
 dePopulate();
 
+// $ExpectType Hook
+dialablePhoneNumber(libphonenumberjs);
+
 // $ExpectType Hook
 disableMultiItemChange();