@feathersjs/feathers 5.0.0 → 5.0.1

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.1](https://github.com/feathersjs/feathers/compare/v5.0.0...v5.0.1) (2023-03-15)
+
+### Bug Fixes
+
+- **core:** Add PaginationParams to general find method ([#3095](https://github.com/feathersjs/feathers/issues/3095)) ([8ebdcf5](https://github.com/feathersjs/feathers/commit/8ebdcf5107fae5fa23920390052b871033de3a0a))
+
 # [5.0.0](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.38...v5.0.0) (2023-02-24)
 
 **Note:** Version bump only for package @feathersjs/feathers

package/lib/declarations.d.ts

@@ -53,7 +53,9 @@ export interface ClientService<Result = any, Data = Partial<Result>, PatchData =
     remove(id: null, params?: P): Promise<Result[]>;
 }
 export interface ServiceMethods<Result = any, Data = Partial<Result>, ServiceParams = Params, PatchData = Partial<Data>> {
-    find(params?: ServiceParams): Promise<Result | Result[]>;
+    find(params?: ServiceParams & {
+        paginate?: PaginationParams;
+    }): Promise<Result | Result[]>;
     get(id: Id, params?: ServiceParams): Promise<Result>;
     create(data: Data, params?: ServiceParams): Promise<Result>;
     update(id: NullableId, data: Data, params?: ServiceParams): Promise<Result | Result[]>;
@@ -85,7 +87,9 @@ export interface ServiceAddons<A = Application, S = Service> extends EventEmitte
     hooks(options: HookOptions<A, S>): this;
 }
 export interface ServiceHookOverloads<S, P = Params> {
-    find(params: P, context: HookContext): Promise<HookContext>;
+    find(params: P & {
+        paginate?: PaginationParams;
+    }, 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>;
@@ -234,6 +238,11 @@ export interface Params<Q = Query> {
         [key: string]: any;
     };
 }
+export interface PaginationOptions {
+    default?: number;
+    max?: number;
+}
+export type PaginationParams = false | PaginationOptions;
 export interface Http {
     /**
      * A writeable, optional property with status code override.

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "5.0.0";
+declare const _default: "5.0.1";
 export default _default;

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '5.0.0';
+exports.default = '5.0.1';
 //# 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",
+  "version": "5.0.1",
   "homepage": "http://feathersjs.com",
   "repository": {
     "type": "git",
@@ -58,17 +58,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/commons": "^5.0.0",
+    "@feathersjs/commons": "^5.0.1",
     "@feathersjs/hooks": "^0.8.1",
     "events": "^3.3.0"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.14.1",
+    "@types/node": "^18.14.6",
     "mocha": "^10.2.0",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5"
   },
-  "gitHead": "90caf635aec850550b9d37bea2762af959d9e8d5"
+  "gitHead": "18b7f4ab0a8075572a81d78956ba1205a9795c91"
 }

package/src/declarations.ts

@@ -72,7 +72,7 @@ export interface ServiceMethods<
   ServiceParams = Params,
   PatchData = Partial<Data>
 > {
-  find(params?: ServiceParams): Promise<Result | Result[]>
+  find(params?: ServiceParams & { paginate?: PaginationParams }): Promise<Result | Result[]>
 
   get(id: Id, params?: ServiceParams): Promise<Result>
 
@@ -137,7 +137,7 @@ export interface ServiceAddons<A = Application, S = Service> extends EventEmitte
 }
 
 export interface ServiceHookOverloads<S, P = Params> {
-  find(params: P, context: HookContext): Promise<HookContext>
+  find(params: P & { paginate?: PaginationParams }, context: HookContext): Promise<HookContext>
 
   get(id: Id, params: P, context: HookContext): Promise<HookContext>
 
@@ -331,6 +331,13 @@ export interface Params<Q = Query> {
   headers?: { [key: string]: any }
 }
 
+export interface PaginationOptions {
+  default?: number
+  max?: number
+}
+
+export type PaginationParams = false | PaginationOptions
+
 export interface Http {
   /**
    * A writeable, optional property with status code override.

package/src/version.ts

@@ -1 +1 @@
-export default '5.0.0'
+export default '5.0.1'