@feathersjs/schema 5.0.0-pre.20 → 5.0.0-pre.23

package/src/schema.ts

@@ -1,60 +1,60 @@
-import Ajv, { AsyncValidateFunction, ValidateFunction } from 'ajv';
-import { FromSchema, JSONSchema } from 'json-schema-to-ts';
-import { BadRequest } from '@feathersjs/errors';
+import Ajv, { AsyncValidateFunction, ValidateFunction } from 'ajv'
+import { FromSchema, JSONSchema } from 'json-schema-to-ts'
+import { BadRequest } from '@feathersjs/errors'
 
 export const DEFAULT_AJV = new Ajv({
   coerceTypes: true
-});
+})
 
-export { Ajv };
+export { Ajv }
 
 export type JSONSchemaDefinition = JSONSchema & {
-  $id: string,
-  $async?: boolean,
+  $id: string
+  $async?: boolean
   properties?: { [key: string]: JSONSchema }
   required?: readonly string[]
-};
+}
 
 export interface Schema<T> {
-  validate <X = T> (...args: Parameters<ValidateFunction<X>>): Promise<X>;
+  validate<X = T>(...args: Parameters<ValidateFunction<X>>): Promise<X>
 }
 
 export class SchemaWrapper<S extends JSONSchemaDefinition> implements Schema<FromSchema<S>> {
-  ajv: Ajv;
-  validator: AsyncValidateFunction;
-  readonly _type!: FromSchema<S>;
+  ajv: Ajv
+  validator: AsyncValidateFunction
+  readonly _type!: FromSchema<S>
 
-  constructor (public definition: S, ajv: Ajv = DEFAULT_AJV) {
-    this.ajv = ajv;
+  constructor(public definition: S, ajv: Ajv = DEFAULT_AJV) {
+    this.ajv = ajv
     this.validator = this.ajv.compile({
       $async: true,
       ...(this.definition as any)
-    }) as AsyncValidateFunction;
+    }) as AsyncValidateFunction
   }
 
-  get properties () {
-    return this.definition.properties as S['properties'];
+  get properties() {
+    return this.definition.properties as S['properties']
   }
 
-  get required () {
-    return this.definition.required as S['required'];
+  get required() {
+    return this.definition.required as S['required']
   }
 
-  async validate <T = FromSchema<S>> (...args: Parameters<ValidateFunction<T>>) {
+  async validate<T = FromSchema<S>>(...args: Parameters<ValidateFunction<T>>) {
     try {
-      const validated = await this.validator(...args) as T;
+      const validated = (await this.validator(...args)) as T
 
-      return validated;
+      return validated
     } catch (error: any) {
-      throw new BadRequest(error.message, error.errors);
+      throw new BadRequest(error.message, error.errors)
     }
   }
 
-  toJSON () {
-    return this.definition;
+  toJSON() {
+    return this.definition
   }
 }
 
-export function schema <S extends JSONSchemaDefinition> (definition: S, ajv: Ajv = DEFAULT_AJV) {
-  return new SchemaWrapper(definition, ajv);
+export function schema<S extends JSONSchemaDefinition>(definition: S, ajv: Ajv = DEFAULT_AJV) {
+  return new SchemaWrapper(definition, ajv)
 }

package/lib/hooks.d.ts

@@ -1,8 +0,0 @@
-import { HookContext, NextFunction } from '@feathersjs/feathers';
-import { Resolver } from './resolver';
-import { Schema } from './schema';
-export declare const resolveQuery: <T>(...resolvers: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>[]) => (context: HookContext, next?: NextFunction) => Promise<any>;
-export declare const resolveData: <T>(...resolvers: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>[]) => (context: HookContext, next?: NextFunction) => Promise<any>;
-export declare const resolveResult: <T>(...resolvers: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>[]) => (context: HookContext, next?: NextFunction) => Promise<void>;
-export declare const validateQuery: (schema: Schema<any>) => (context: HookContext, next?: NextFunction) => Promise<any>;
-export declare const validateData: (schema: Schema<any>) => (context: HookContext, next?: NextFunction) => Promise<any>;

package/lib/hooks.js

@@ -1,119 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateData = exports.validateQuery = exports.resolveResult = exports.resolveData = exports.resolveQuery = void 0;
-const lib_1 = require("../../errors/lib");
-const getContext = (context) => {
-    return {
-        ...context,
-        params: {
-            ...context.params,
-            query: {}
-        }
-    };
-};
-const runResolvers = async (resolvers, data, ctx, status) => {
-    let current = data;
-    for (const resolver of resolvers) {
-        current = await resolver.resolve(current, ctx, status);
-    }
-    return current;
-};
-const resolveQuery = (...resolvers) => async (context, next) => {
-    var _a;
-    const ctx = getContext(context);
-    const data = ((_a = context === null || context === void 0 ? void 0 : context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
-    const query = await runResolvers(resolvers, data, ctx);
-    context.params = {
-        ...context.params,
-        query
-    };
-    if (typeof next === 'function') {
-        return next();
-    }
-};
-exports.resolveQuery = resolveQuery;
-const resolveData = (...resolvers) => async (context, next) => {
-    const ctx = getContext(context);
-    const data = context.data;
-    const status = {
-        originalContext: context
-    };
-    if (Array.isArray(data)) {
-        context.data = await Promise.all(data.map(current => runResolvers(resolvers, current, ctx, status)));
-    }
-    else {
-        context.data = await runResolvers(resolvers, data, ctx, status);
-    }
-    if (typeof next === 'function') {
-        return next();
-    }
-};
-exports.resolveData = resolveData;
-const resolveResult = (...resolvers) => async (context, next) => {
-    var _a;
-    if (typeof next === 'function') {
-        const { $resolve: properties, ...query } = ((_a = context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
-        const resolve = {
-            originalContext: context,
-            ...context.params.resolve,
-            properties
-        };
-        context.params = {
-            ...context.params,
-            resolve,
-            query
-        };
-        await next();
-    }
-    const ctx = getContext(context);
-    const status = context.params.resolve;
-    const isPaginated = context.method === 'find' && context.result.data;
-    const data = isPaginated ? context.result.data : context.result;
-    const result = Array.isArray(data) ?
-        await Promise.all(data.map(async (current) => runResolvers(resolvers, current, ctx, status))) :
-        await runResolvers(resolvers, data, ctx, status);
-    if (isPaginated) {
-        context.result.data = result;
-    }
-    else {
-        context.result = result;
-    }
-};
-exports.resolveResult = resolveResult;
-const validateQuery = (schema) => async (context, next) => {
-    var _a;
-    const data = ((_a = context === null || context === void 0 ? void 0 : context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
-    try {
-        const query = await schema.validate(data);
-        context.params = {
-            ...context.params,
-            query
-        };
-        if (typeof next === 'function') {
-            return next();
-        }
-    }
-    catch (error) {
-        throw (error.ajv ? new lib_1.BadRequest(error.message, error.errors) : error);
-    }
-};
-exports.validateQuery = validateQuery;
-const validateData = (schema) => async (context, next) => {
-    const data = context.data;
-    try {
-        if (Array.isArray(data)) {
-            context.data = await Promise.all(data.map(current => schema.validate(current)));
-        }
-        else {
-            context.data = await schema.validate(data);
-        }
-    }
-    catch (error) {
-        throw (error.ajv ? new lib_1.BadRequest(error.message, error.errors) : error);
-    }
-    if (typeof next === 'function') {
-        return next();
-    }
-};
-exports.validateData = validateData;
-//# sourceMappingURL=hooks.js.map

package/lib/hooks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":";;;AACA,0CAA8C;AAI9C,MAAM,UAAU,GAAG,CAAC,OAAoB,EAAE,EAAE;IAC1C,OAAO;QACL,GAAG,OAAO;QACV,MAAM,EAAE;YACN,GAAG,OAAO,CAAC,MAAM;YACjB,KAAK,EAAE,EAAE;SACV;KACF,CAAA;AACH,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,KAAK,EACxB,SAAqC,EACrC,IAAS,EACT,GAAgB,EAChB,MAAgD,EAChD,EAAE;IACF,IAAI,OAAO,GAAQ,IAAI,CAAC;IAExB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,OAAO,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KACxD;IAED,OAAO,OAAY,CAAC;AACtB,CAAC,CAAA;AAEM,MAAM,YAAY,GAAG,CAAK,GAAG,SAAqC,EAAE,EAAE,CAC3E,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;;IAClD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IAEvD,OAAO,CAAC,MAAM,GAAG;QACf,GAAG,OAAO,CAAC,MAAM;QACjB,KAAK;KACN,CAAA;IAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,OAAO,IAAI,EAAE,CAAC;KACf;AACH,CAAC,CAAC;AAdS,QAAA,YAAY,gBAcrB;AAEG,MAAM,WAAW,GAAG,CAAK,GAAG,SAAqC,EAAE,EAAE,CAC1E,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;IAClD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,MAAM,MAAM,GAAG;QACb,eAAe,EAAE,OAAO;KACzB,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,CAAC,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAClD,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAC9C,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,CAAC,IAAI,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KACjE;IAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,OAAO,IAAI,EAAE,CAAC;KACf;AACH,CAAC,CAAC;AAnBS,QAAA,WAAW,eAmBpB;AAEG,MAAM,aAAa,GAAG,CAAK,GAAG,SAAqC,EAAE,EAAE,CAC5E,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;;IAClD,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,CAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;QACvE,MAAM,OAAO,GAAG;YACd,eAAe,EAAE,OAAO;YACxB,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO;YACzB,UAAU;SACX,CAAC;QAEF,OAAO,CAAC,MAAM,GAAG;YACf,GAAG,OAAO,CAAC,MAAM;YACjB,OAAO;YACP,KAAK;SACN,CAAA;QAED,MAAM,IAAI,EAAE,CAAC;KACd;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;IAEtC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IACrE,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAEhE,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7F,MAAM,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAEnD,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;KAC9B;SAAM;QACL,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;KACzB;AACH,CAAC,CAAC;AAlCS,QAAA,aAAa,iBAkCtB;AAEG,MAAM,aAAa,GAAG,CAAC,MAAmB,EAAE,EAAE,CACnD,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;;IAClD,MAAM,IAAI,GAAG,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;IAE1C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE1C,OAAO,CAAC,MAAM,GAAG;YACf,GAAG,OAAO,CAAC,MAAM;YACjB,KAAK;SACN,CAAA;QAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;YAC9B,OAAO,IAAI,EAAE,CAAC;SACf;KACF;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;KACzE;AACH,CAAC,CAAC;AAlBS,QAAA,aAAa,iBAkBtB;AAEG,MAAM,YAAY,GAAG,CAAC,MAAmB,EAAE,EAAE,CAClD,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;IAClD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1B,IAAI;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,OAAO,CAAC,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAClD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CACzB,CAAC,CAAC;SACJ;aAAM;YACL,OAAO,CAAC,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC5C;KACF;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;KACzE;IAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,OAAO,IAAI,EAAE,CAAC;KACf;AACH,CAAC,CAAC;AAnBS,QAAA,YAAY,gBAmBrB"}

package/src/hooks.ts

@@ -1,143 +0,0 @@
-import { HookContext, NextFunction } from '@feathersjs/feathers';
-import { BadRequest } from '../../errors/lib';
-import { Resolver, ResolverStatus } from './resolver';
-import { Schema } from './schema';
-
-const getContext = (context: HookContext) => {
-  return {
-    ...context,
-    params: {
-      ...context.params,
-      query: {}
-    }
-  }
-}
-
-const runResolvers = async <T> (
-  resolvers: Resolver<T, HookContext>[],
-  data: any,
-  ctx: HookContext,
-  status?: Partial<ResolverStatus<T, HookContext>>
-) => {
-  let current: any = data;
-
-  for (const resolver of resolvers) {
-    current = await resolver.resolve(current, ctx, status);
-  }
-
-  return current as T;
-}
-
-export const resolveQuery = <T> (...resolvers: Resolver<T, HookContext>[]) =>
-  async (context: HookContext, next?: NextFunction) => {
-    const ctx = getContext(context);
-    const data = context?.params?.query || {};
-    const query = await runResolvers(resolvers, data, ctx);
-
-    context.params = {
-      ...context.params,
-      query
-    }
-
-    if (typeof next === 'function') {
-      return next();
-    }
-  };
-
-export const resolveData = <T> (...resolvers: Resolver<T, HookContext>[]) =>
-  async (context: HookContext, next?: NextFunction) => {
-    const ctx = getContext(context);
-    const data = context.data;
-    const status = {
-      originalContext: context
-    };
-
-    if (Array.isArray(data)) {
-      context.data = await Promise.all(data.map(current =>
-        runResolvers(resolvers, current, ctx, status)
-      ));
-    } else {
-      context.data = await runResolvers(resolvers, data, ctx, status);
-    }
-
-    if (typeof next === 'function') {
-      return next();
-    }
-  };
-
-export const resolveResult = <T> (...resolvers: Resolver<T, HookContext>[]) =>
-  async (context: HookContext, next?: NextFunction) => {
-    if (typeof next === 'function') {
-      const { $resolve: properties, ...query } = context.params?.query || {};
-      const resolve = {
-        originalContext: context,
-        ...context.params.resolve,
-        properties
-      };
-
-      context.params = {
-        ...context.params,
-        resolve,
-        query
-      }
-
-      await next();
-    }
-
-    const ctx = getContext(context);
-    const status = context.params.resolve;
-
-    const isPaginated = context.method === 'find' && context.result.data;
-    const data = isPaginated ? context.result.data : context.result;
-
-    const result = Array.isArray(data) ?
-      await Promise.all(data.map(async current => runResolvers(resolvers, current, ctx, status))) :
-      await runResolvers(resolvers, data, ctx, status);
-
-    if (isPaginated) {
-      context.result.data = result;
-    } else {
-      context.result = result;
-    }
-  };
-
-export const validateQuery = (schema: Schema<any>) =>
-  async (context: HookContext, next?: NextFunction) => {
-    const data = context?.params?.query || {};
-
-    try {
-      const query = await schema.validate(data);
-
-      context.params = {
-        ...context.params,
-        query
-      }
-
-      if (typeof next === 'function') {
-        return next();
-      }
-    } catch (error: any) {
-      throw (error.ajv ? new BadRequest(error.message, error.errors) : error);
-    }
-  };
-
-export const validateData = (schema: Schema<any>) =>
-  async (context: HookContext, next?: NextFunction) => {
-    const data = context.data;
-
-    try {
-      if (Array.isArray(data)) {
-        context.data = await Promise.all(data.map(current =>
-          schema.validate(current)
-        ));
-      } else {
-        context.data = await schema.validate(data);
-      }
-    } catch (error: any) {
-      throw (error.ajv ? new BadRequest(error.message, error.errors) : error);
-    }
-
-    if (typeof next === 'function') {
-      return next();
-    }
-  };