Merge pull request feathersjs-ecosystem#502 from j2L4e/seqeulizeConvert

add types for sequelizeConvert hook

Author: eddyystop

types/index.d.ts

@@ -456,6 +456,24 @@ export function setNow(...fieldNames: string[]): Hook;
  */
 export function setSlug(slug: string, fieldName?: string): Hook;
 
+export interface SequelizeConversion {
+    js: (sqlValue: any) => any;
+    sql: (jsValue: any) => any;
+}
+
+export interface SequelizeConverts<C> {
+    [name: string]: keyof C | 'boolean' | 'date' | 'json';
+}
+
+/**
+ * {@link https://feathers-plus.github.io/v1/feathers-hooks-common/index.html#SequelizeConvert}
+ */
+export function sequelizeConvert<C extends {[name: string]: SequelizeConversion}>(
+    converts: SequelizeConverts<C> | null | undefined | false,
+    ignores: string[] | null | undefined | false,
+    conversions?: C
+): Hook;
+
 /**
  * Filter data or result records using a MongoDB-like selection syntax.
  * {@link https://feathers-plus.github.io/v1/feathers-hooks-common/index.html#Sifter}

types/tests.ts

@@ -25,6 +25,7 @@ import {
     existsByDot,
     fastJoin,
     fgraphql,
+    FGraphQLHookOptions,
     getByDot,
     getItems,
     iff,
@@ -47,6 +48,7 @@ import {
     ResolverMap,
     runHook,
     runParallel,
+    sequelizeConvert,
     serialize,
     setByDot,
     setNow,
@@ -63,11 +65,10 @@ import {
     validate,
     validateSchema,
     when,
-    FGraphQLHookOptions,
 } from 'feathers-hooks-common';
-import ajv = require('ajv');
 import { parse } from 'graphql';
 import * as libphonenumberjs from 'libphonenumber-js';
+import ajv = require('ajv');
 
 const context1: HookContext = {
     type: 'before',
@@ -386,6 +387,19 @@ setNow('createdAt', 'updatedAt');
 // $ExpectType Hook
 setSlug('storeId');
 
+// $ExpectType Hook
+sequelizeConvert ({
+    aBool: 'boolean',
+    aDate: 'date',
+    anObject: 'json',
+    aNumber: 'strToInt'
+}, null, {
+    strToInt: {
+        js: (sqlValue: string) => +sqlValue,
+        sql: (jsValue: number) => `${jsValue}`,
+    }
+});
+
 // $ExpectType Hook
 sifter(ctx => item => true);