@feathersjs/feathers 5.0.0-pre.18 → 5.0.0-pre.20

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0-pre.20](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.19...v5.0.0-pre.20) (2022-05-04)
+
+
+### Bug Fixes
+
+* **dependencies:** Lock monorepo package version numbers ([#2623](https://github.com/feathersjs/feathers/issues/2623)) ([5640c10](https://github.com/feathersjs/feathers/commit/5640c1020cc139994e695d658c08bad3494db507))
+
+
+
+
+
+# [5.0.0-pre.19](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.18...v5.0.0-pre.19) (2022-05-01)
+
+
+### Features
+
+* **typescript:** Improve adapter typings ([#2605](https://github.com/feathersjs/feathers/issues/2605)) ([3b2ca0a](https://github.com/feathersjs/feathers/commit/3b2ca0a6a8e03e8390272c4d7e930b4bffdaacf5))
+* **typescript:** Improve params and query typeability ([#2600](https://github.com/feathersjs/feathers/issues/2600)) ([df28b76](https://github.com/feathersjs/feathers/commit/df28b7619161f1df5e700326f52cca1a92dc5d28))
+
+
+
+
+
 # [5.0.0-pre.18](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.17...v5.0.0-pre.18) (2022-04-11)
 
 

package/lib/declarations.d.ts

@@ -17,38 +17,38 @@ export interface ServiceOptions {
         [key: string]: any;
     };
 }
-export interface ServiceMethods<T = any, D = Partial<T>> {
-    find(params?: Params): Promise<T | T[]>;
-    get(id: Id, params?: Params): Promise<T>;
-    create(data: D, params?: Params): Promise<T>;
-    update(id: NullableId, data: D, params?: Params): Promise<T | T[]>;
-    patch(id: NullableId, data: D, params?: Params): Promise<T | T[]>;
-    remove(id: NullableId, params?: Params): Promise<T | T[]>;
-    setup(app: Application, path: string): Promise<void>;
-    teardown(app: Application, path: string): Promise<void>;
+export interface ServiceMethods<T = any, D = Partial<T>, P = Params> {
+    find(params?: P): Promise<T | T[]>;
+    get(id: Id, params?: P): Promise<T>;
+    create(data: D, params?: P): Promise<T>;
+    update(id: NullableId, data: D, params?: P): Promise<T | T[]>;
+    patch(id: NullableId, data: D, params?: P): Promise<T | T[]>;
+    remove(id: NullableId, params?: P): Promise<T | T[]>;
+    setup?(app: Application, path: string): Promise<void>;
+    teardown?(app: Application, path: string): Promise<void>;
 }
-export interface ServiceOverloads<T = any, D = Partial<T>> {
-    create?(data: D[], params?: Params): Promise<T[]>;
-    update?(id: Id, data: D, params?: Params): Promise<T>;
-    update?(id: null, data: D, params?: Params): Promise<T[]>;
-    patch?(id: Id, data: D, params?: Params): Promise<T>;
-    patch?(id: null, data: D, params?: Params): Promise<T[]>;
-    remove?(id: Id, params?: Params): Promise<T>;
-    remove?(id: null, params?: Params): Promise<T[]>;
+export interface ServiceOverloads<T = any, D = Partial<T>, P = Params> {
+    create?(data: D[], params?: P): Promise<T[]>;
+    update?(id: Id, data: D, params?: P): Promise<T>;
+    update?(id: null, data: D, params?: P): Promise<T[]>;
+    patch?(id: Id, data: D, params?: P): Promise<T>;
+    patch?(id: null, data: D, params?: P): Promise<T[]>;
+    remove?(id: Id, params?: P): Promise<T>;
+    remove?(id: null, params?: P): Promise<T[]>;
 }
-export declare type Service<T = any, D = Partial<T>> = ServiceMethods<T, D> & ServiceOverloads<T, D>;
-export declare type ServiceInterface<T = any, D = Partial<T>> = Partial<ServiceMethods<T, D>>;
+export declare type Service<T = any, D = Partial<T>, P = Params> = ServiceMethods<T, D, P> & ServiceOverloads<T, D, P>;
+export declare type ServiceInterface<T = any, D = Partial<T>, P = Params> = Partial<ServiceMethods<T, D, P>>;
 export interface ServiceAddons<A = Application, S = Service> extends EventEmitter {
     id?: string;
     hooks(options: HookOptions<A, S>): this;
 }
-export interface ServiceHookOverloads<S> {
-    find(params: Params, context: HookContext): Promise<HookContext>;
-    get(id: Id, params: Params, context: HookContext): Promise<HookContext>;
-    create(data: ServiceGenericData<S> | ServiceGenericData<S>[], params: Params, context: HookContext): Promise<HookContext>;
-    update(id: NullableId, data: ServiceGenericData<S>, params: Params, context: HookContext): Promise<HookContext>;
-    patch(id: NullableId, data: ServiceGenericData<S>, params: Params, context: HookContext): Promise<HookContext>;
-    remove(id: NullableId, params: Params, context: HookContext): Promise<HookContext>;
+export interface ServiceHookOverloads<S, P = Params> {
+    find(params: P, context: HookContext): Promise<HookContext>;
+    get(id: Id, params: P, context: HookContext): Promise<HookContext>;
+    create(data: ServiceGenericData<S> | ServiceGenericData<S>[], params: P, context: HookContext): Promise<HookContext>;
+    update(id: NullableId, data: ServiceGenericData<S>, params: P, context: HookContext): Promise<HookContext>;
+    patch(id: NullableId, data: ServiceGenericData<S>, params: P, context: HookContext): Promise<HookContext>;
+    remove(id: NullableId, params: P, context: HookContext): Promise<HookContext>;
 }
 export declare type FeathersService<A = FeathersApplication, S = Service> = S & ServiceAddons<A, S> & OptionalPick<ServiceHookOverloads<S>, keyof S>;
 export declare type CustomMethods<T extends {
@@ -59,6 +59,7 @@ export declare type CustomMethods<T extends {
 export declare type ServiceMixin<A> = (service: FeathersService<A>, path: string, options: ServiceOptions) => void;
 export declare type ServiceGenericType<S> = S extends ServiceInterface<infer T> ? T : any;
 export declare type ServiceGenericData<S> = S extends ServiceInterface<infer _T, infer D> ? D : any;
+export declare type ServiceGenericParams<S> = S extends ServiceInterface<infer _T, infer _D, infer P> ? P : any;
 export interface FeathersApplication<Services = any, Settings = any> {
     /**
      * The Feathers application version
@@ -160,8 +161,8 @@ export declare type NullableId = Id | null;
 export interface Query {
     [key: string]: any;
 }
-export interface Params {
-    query?: Query;
+export interface Params<Q = Query> {
+    query?: Q;
     provider?: string;
     route?: {
         [key: string]: any;
@@ -169,7 +170,6 @@ export interface Params {
     headers?: {
         [key: string]: any;
     };
-    [key: string]: any;
 }
 export interface Http {
     /**
@@ -237,7 +237,7 @@ export interface HookContext<A = Application, S = any> extends BaseHookContext<S
      * A writeable property that contains the service method parameters (including
      * params.query).
      */
-    params: Params;
+    params: ServiceGenericParams<S>;
     /**
      * A writeable property containing the result of the successful service method call.
      * It is only available in after hooks.

package/lib/events.d.ts

@@ -1,4 +1,4 @@
 import { NextFunction } from './dependencies';
 import { HookContext, FeathersService } from './declarations';
 export declare function eventHook(context: HookContext, next: NextFunction): Promise<void>;
-export declare function eventMixin<A>(service: FeathersService<A>): FeathersService<A, import("./declarations").Service<any, Partial<any>>>;
+export declare function eventMixin<A>(service: FeathersService<A>): FeathersService<A, import("./declarations").Service<any, Partial<any>, import("./declarations").Params<import("./declarations").Query>>>;

package/lib/hooks/index.d.ts

@@ -10,4 +10,4 @@ export declare class FeathersHookManager<A> extends HookManager {
     initializeContext(self: any, args: any[], context: HookContext): import("@feathersjs/hooks/types/base").HookContext<any, any>;
     middleware(mw: Middleware[]): this;
 }
-export declare function hookMixin<A>(this: A, service: FeathersService<A>, path: string, options: ServiceOptions): FeathersService<A, Service<any, Partial<any>>>;
+export declare function hookMixin<A>(this: A, service: FeathersService<A>, path: string, options: ServiceOptions): FeathersService<A, Service<any, Partial<any>, import("../declarations").Params<import("../declarations").Query>>>;

package/lib/hooks/regular.d.ts

@@ -7,6 +7,6 @@ export declare function fromAfterHooks<A, S>(hooks: RegularHookFunction<A, S>[])
 export declare function fromErrorHooks<A, S>(hooks: RegularHookFunction<A, S>[]): HookFunction<unknown, unknown>;
 export declare function collectRegularHooks(target: any, method: string): any;
 export declare function convertHookData(input: any): {
-    [method: string]: RegularHookFunction<import("../declarations").Application<any, any>, import("../declarations").Service<any, Partial<any>>>[];
+    [method: string]: RegularHookFunction<import("../declarations").Application<any, any>, import("../declarations").Service<any, Partial<any>, import("../declarations").Params<import("../declarations").Query>>>[];
 };
 export declare function enableRegularHooks(object: any, methods?: string[]): (this: any, input: RegularHookMap<any, any>) => any;

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "5.0.0-pre.18";
+declare const _default: "5.0.0-pre.20";
 export default _default;

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '5.0.0-pre.18';
+exports.default = '5.0.0-pre.20';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/feathers",
   "description": "A framework for real-time applications and REST API with JavaScript and TypeScript",
-  "version": "5.0.0-pre.18",
+  "version": "5.0.0-pre.20",
   "homepage": "http://feathersjs.com",
   "repository": {
     "type": "git",
@@ -57,17 +57,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/commons": "^5.0.0-pre.18",
-    "@feathersjs/hooks": "^0.7.3",
+    "@feathersjs/commons": "^5.0.0-pre.20",
+    "@feathersjs/hooks": "^0.7.4",
     "events": "^3.3.0"
   },
   "devDependencies": {
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.23",
-    "mocha": "^9.2.2",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.31",
+    "mocha": "^10.0.0",
     "shx": "^0.3.4",
     "ts-node": "^10.7.0",
-    "typescript": "^4.6.3"
+    "typescript": "^4.6.4"
   },
-  "gitHead": "c0b7b67d872dcd6b6d94e4587f21332c8a519b50"
+  "gitHead": "54de749a0b392c7da726c668002b50cafaca530c"
 }

package/src/declarations.ts

@@ -21,87 +21,87 @@ export interface ServiceOptions {
   routeParams?: { [key: string]: any };
 }
 
-export interface ServiceMethods<T = any, D = Partial<T>> {
-  find (params?: Params): Promise<T | T[]>;
+export interface ServiceMethods<T = any, D = Partial<T>, P = Params> {
+  find (params?: P): Promise<T | T[]>;
 
-  get (id: Id, params?: Params): Promise<T>;
+  get (id: Id, params?: P): Promise<T>;
 
-  create (data: D, params?: Params): Promise<T>;
+  create (data: D, params?: P): Promise<T>;
 
-  update (id: NullableId, data: D, params?: Params): Promise<T | T[]>;
+  update (id: NullableId, data: D, params?: P): Promise<T | T[]>;
 
-  patch (id: NullableId, data: D, params?: Params): Promise<T | T[]>;
+  patch (id: NullableId, data: D, params?: P): Promise<T | T[]>;
 
-  remove (id: NullableId, params?: Params): Promise<T | T[]>;
+  remove (id: NullableId, params?: P): Promise<T | T[]>;
 
-  setup (app: Application, path: string): Promise<void>;
+  setup? (app: Application, path: string): Promise<void>;
 
-  teardown (app: Application, path: string): Promise<void>;
+  teardown? (app: Application, path: string): Promise<void>;
 }
 
-export interface ServiceOverloads<T = any, D = Partial<T>> {
-  create? (data: D[], params?: Params): Promise<T[]>;
+export interface ServiceOverloads<T = any, D = Partial<T>, P = Params> {
+  create? (data: D[], params?: P): Promise<T[]>;
 
-  update? (id: Id, data: D, params?: Params): Promise<T>;
+  update? (id: Id, data: D, params?: P): Promise<T>;
 
-  update? (id: null, data: D, params?: Params): Promise<T[]>;
+  update? (id: null, data: D, params?: P): Promise<T[]>;
 
-  patch? (id: Id, data: D, params?: Params): Promise<T>;
+  patch? (id: Id, data: D, params?: P): Promise<T>;
 
-  patch? (id: null, data: D, params?: Params): Promise<T[]>;
+  patch? (id: null, data: D, params?: P): Promise<T[]>;
 
-  remove? (id: Id, params?: Params): Promise<T>;
+  remove? (id: Id, params?: P): Promise<T>;
 
-  remove? (id: null, params?: Params): Promise<T[]>;
+  remove? (id: null, params?: P): Promise<T[]>;
 }
 
-export type Service<T = any, D = Partial<T>> =
-  ServiceMethods<T, D> &
-  ServiceOverloads<T, D>;
+export type Service<T = any, D = Partial<T>, P = Params> =
+  ServiceMethods<T, D, P> &
+  ServiceOverloads<T, D, P>;
 
-export type ServiceInterface<T = any, D = Partial<T>> =
-  Partial<ServiceMethods<T, D>>;
+export type ServiceInterface<T = any, D = Partial<T>, P = Params> =
+  Partial<ServiceMethods<T, D, P>>;
 
 export interface ServiceAddons<A = Application, S = Service> extends EventEmitter {
   id?: string;
   hooks (options: HookOptions<A, S>): this;
 }
 
-export interface ServiceHookOverloads<S> {
+export interface ServiceHookOverloads<S, P = Params> {
   find (
-    params: Params,
+    params: P,
     context: HookContext
   ): Promise<HookContext>;
 
   get (
     id: Id,
-    params: Params,
+    params: P,
     context: HookContext
   ): Promise<HookContext>;
 
   create (
     data: ServiceGenericData<S> | ServiceGenericData<S>[],
-    params: Params,
+    params: P,
     context: HookContext
   ): Promise<HookContext>;
 
   update (
     id: NullableId,
     data: ServiceGenericData<S>,
-    params: Params,
+    params: P,
     context: HookContext
   ): Promise<HookContext>;
 
   patch (
     id: NullableId,
     data: ServiceGenericData<S>,
-    params: Params,
+    params: P,
     context: HookContext
   ): Promise<HookContext>;
 
   remove (
     id: NullableId,
-    params: Params,
+    params: P,
     context: HookContext
   ): Promise<HookContext>;
 }
@@ -117,6 +117,7 @@ export type ServiceMixin<A> = (service: FeathersService<A>, path: string, option
 
 export type ServiceGenericType<S> = S extends ServiceInterface<infer T> ? T : any;
 export type ServiceGenericData<S> = S extends ServiceInterface<infer _T, infer D> ? D : any;
+export type ServiceGenericParams<S> = S extends ServiceInterface<infer _T, infer _D, infer P> ? P : any;
 
 export interface FeathersApplication<Services = any, Settings = any> {
   /**
@@ -246,12 +247,11 @@ export interface Query {
   [key: string]: any;
 }
 
-export interface Params {
-  query?: Query;
+export interface Params<Q = Query> {
+  query?: Q;
   provider?: string;
   route?: { [key: string]: any };
   headers?: { [key: string]: any };
-  [key: string]: any; // (JL) not sure if we want this
 }
 
 export interface Http {
@@ -319,7 +319,7 @@ export interface HookContext<A = Application, S = any> extends BaseHookContext<S
    * A writeable property that contains the service method parameters (including
    * params.query).
    */
-  params: Params;
+  params: ServiceGenericParams<S>;
   /**
    * A writeable property containing the result of the successful service method call.
    * It is only available in after hooks.

package/src/version.ts

@@ -1 +1 @@
-export default '5.0.0-pre.18';
+export default '5.0.0-pre.20';