feathers-utils 2.0.0-2 → 2.0.0-3

package/dist/esm/filters/array.d.ts

@@ -1,2 +1,2 @@
 import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare const filterArray: () => (arr: any, { operators }: FilterQueryOptions) => any;
+export declare const filterArray: (key: string) => (arr: any, { operators }: FilterQueryOptions) => any;

package/dist/esm/filters/array.js

@@ -1,7 +1,7 @@
 import { validateQueryProperty } from "../utils/validateQueryProperty";
-export const filterArray = () => (arr, { operators }) => {
+export const filterArray = (key) => (arr, { operators }) => {
     if (arr && !Array.isArray(arr)) {
-        throw new Error("Invalid query parameter $and. It has to be an array");
+        throw new Error(`Invalid query parameter '${key}'. It has to be an array`);
     }
     if (Array.isArray(arr)) {
         return arr.map((current) => validateQueryProperty(current, operators));

package/dist/esm/filters/object.d.ts

@@ -0,0 +1,2 @@
+import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
+export declare const filterObject: (key: string) => (obj: any, { operators }: FilterQueryOptions) => import("@feathersjs/feathers/lib").Query;

package/dist/esm/filters/object.js

@@ -0,0 +1,8 @@
+import { validateQueryProperty } from "../utils/validateQueryProperty";
+import _isObject from "lodash/isObject";
+export const filterObject = (key) => (obj, { operators }) => {
+    if (obj && !_isObject(obj)) {
+        throw new Error(`Invalid query parameter: '${key}'. It has to be an object`);
+    }
+    return validateQueryProperty(obj, operators);
+};

package/dist/esm/index.d.ts

@@ -33,4 +33,5 @@ export { onDelete } from "./hooks/onDelete";
 export { shouldSkip } from "./utils/shouldSkip";
 export { validateQueryProperty } from "./utils/validateQueryProperty";
 export { filterArray } from "./filters/array";
+export { filterObject } from "./filters/object";
 export * from "./types";

package/dist/esm/index.js

@@ -34,4 +34,5 @@ export { shouldSkip } from "./utils/shouldSkip";
 export { validateQueryProperty } from "./utils/validateQueryProperty";
 // query filters
 export { filterArray } from "./filters/array";
+export { filterObject } from "./filters/object";
 export * from "./types";

package/dist/filters/array.d.ts

@@ -1,2 +1,2 @@
 import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare const filterArray: () => (arr: any, { operators }: FilterQueryOptions) => any;
+export declare const filterArray: (key: string) => (arr: any, { operators }: FilterQueryOptions) => any;

package/dist/filters/array.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterArray = void 0;
 const validateQueryProperty_1 = require("../utils/validateQueryProperty");
-const filterArray = () => (arr, { operators }) => {
+const filterArray = (key) => (arr, { operators }) => {
     if (arr && !Array.isArray(arr)) {
-        throw new Error("Invalid query parameter $and. It has to be an array");
+        throw new Error(`Invalid query parameter '${key}'. It has to be an array`);
     }
     if (Array.isArray(arr)) {
         return arr.map((current) => (0, validateQueryProperty_1.validateQueryProperty)(current, operators));

package/dist/filters/object.d.ts

@@ -0,0 +1,2 @@
+import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
+export declare const filterObject: (key: string) => (obj: any, { operators }: FilterQueryOptions) => import("@feathersjs/feathers/lib").Query;

package/dist/filters/object.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterObject = void 0;
+const validateQueryProperty_1 = require("../utils/validateQueryProperty");
+const isObject_1 = __importDefault(require("lodash/isObject"));
+const filterObject = (key) => (obj, { operators }) => {
+    if (obj && !(0, isObject_1.default)(obj)) {
+        throw new Error(`Invalid query parameter: '${key}'. It has to be an object`);
+    }
+    return (0, validateQueryProperty_1.validateQueryProperty)(obj, operators);
+};
+exports.filterObject = filterObject;

package/dist/index.d.ts

@@ -33,4 +33,5 @@ export { onDelete } from "./hooks/onDelete";
 export { shouldSkip } from "./utils/shouldSkip";
 export { validateQueryProperty } from "./utils/validateQueryProperty";
 export { filterArray } from "./filters/array";
+export { filterObject } from "./filters/object";
 export * from "./types";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterArray = exports.validateQueryProperty = exports.shouldSkip = exports.onDelete = exports.getItemsIsArray = exports.filterQuery = exports.markHookForSkip = exports.setResultEmpty = exports.pushSet = exports.mergeArrays = exports.mergeQuery = exports.isPaginated = exports.isMulti = exports.getPaginate = exports.DebouncedStore = exports.debounceMixin = exports.mixins = exports.runPerItem = exports.removeRelated = exports.setData = exports.createRelated = exports.checkMulti = exports.hooks = void 0;
+exports.filterObject = exports.filterArray = exports.validateQueryProperty = exports.shouldSkip = exports.onDelete = exports.getItemsIsArray = exports.filterQuery = exports.markHookForSkip = exports.setResultEmpty = exports.pushSet = exports.mergeArrays = exports.mergeQuery = exports.isPaginated = exports.isMulti = exports.getPaginate = exports.DebouncedStore = exports.debounceMixin = exports.mixins = exports.runPerItem = exports.removeRelated = exports.setData = exports.createRelated = exports.checkMulti = exports.hooks = void 0;
 // hooks
 const checkMulti_1 = require("./hooks/checkMulti");
 Object.defineProperty(exports, "checkMulti", { enumerable: true, get: function () { return checkMulti_1.checkMulti; } });
@@ -67,4 +67,6 @@ Object.defineProperty(exports, "validateQueryProperty", { enumerable: true, get:
 // query filters
 var array_1 = require("./filters/array");
 Object.defineProperty(exports, "filterArray", { enumerable: true, get: function () { return array_1.filterArray; } });
+var object_1 = require("./filters/object");
+Object.defineProperty(exports, "filterObject", { enumerable: true, get: function () { return object_1.filterObject; } });
 __exportStar(require("./types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "2.0.0-2",
+  "version": "2.0.0-3",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {

package/src/filters/array.ts

@@ -1,9 +1,9 @@
 import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
 import { validateQueryProperty } from "../utils/validateQueryProperty";
 
-export const filterArray = () => (arr: any, { operators }: FilterQueryOptions) => {
+export const filterArray = (key: string) => (arr: any, { operators }: FilterQueryOptions) => {
   if (arr && !Array.isArray(arr)) {
-    throw new Error("Invalid query parameter $and. It has to be an array");
+    throw new Error(`Invalid query parameter '${key}'. It has to be an array`);
   }
 
   if (Array.isArray(arr)) {

package/src/filters/object.ts

@@ -0,0 +1,11 @@
+import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
+import { validateQueryProperty } from "../utils/validateQueryProperty";
+import _isObject from "lodash/isObject";
+
+export const filterObject = (key: string) => (obj: any, { operators }: FilterQueryOptions) => {
+  if (obj && !_isObject(obj)) {
+    throw new Error(`Invalid query parameter: '${key}'. It has to be an object`);
+  }
+
+  return validateQueryProperty(obj, operators);
+};

package/src/index.ts

@@ -46,5 +46,6 @@ export { validateQueryProperty } from "./utils/validateQueryProperty";
 
 // query filters
 export { filterArray } from "./filters/array";
+export { filterObject } from "./filters/object";
 
 export * from "./types";