@point-hub/papi 0.5.15 → 0.5.16

package/lib/index.js

@@ -71821,6 +71821,75 @@ class DatabaseTestUtil {
     return await DatabaseTestUtil.dbConnection.collection(collection).retrieveAll(query);
   }
 }
+// src/database/mongodb/mongodb-query-filters.ts
+var addRegexFilter = (filters, field, value) => {
+  if (value?.trim()) {
+    filters.push({ [field]: { $regex: value.trim(), $options: "i" } });
+  }
+};
+var addNumberFilter = (filters, field, value) => {
+  if (typeof value !== "string" || value.trim() === "")
+    return;
+  const constraints = parseComparisons(value);
+  const mongoFilter = {};
+  if (constraints.eq !== undefined) {
+    filters.push({ [field]: constraints.eq });
+    return;
+  }
+  if (constraints.gt !== undefined)
+    mongoFilter["$gt"] = constraints.gt;
+  if (constraints.gte !== undefined)
+    mongoFilter["$gte"] = constraints.gte;
+  if (constraints.lt !== undefined)
+    mongoFilter["$lt"] = constraints.lt;
+  if (constraints.lte !== undefined)
+    mongoFilter["$lte"] = constraints.lte;
+  if (Object.keys(mongoFilter).length > 0) {
+    filters.push({ [field]: mongoFilter });
+  }
+};
+var parseComparisons = (expr) => {
+  const cleanedExpr = expr.replace(/\s+/g, "");
+  if (/^\d+$/.test(cleanedExpr)) {
+    return { eq: parseInt(cleanedExpr, 10) };
+  }
+  const regex = /(<=|>=|<|>)(\d+)/g;
+  const result = {};
+  let matchedStr = "";
+  let hasLowerBound = false;
+  let hasUpperBound = false;
+  let match;
+  while ((match = regex.exec(cleanedExpr)) !== null) {
+    const [full, operator, valueStr] = match;
+    const value = parseInt(valueStr, 10);
+    matchedStr += full;
+    switch (operator) {
+      case ">":
+      case ">=":
+        if (hasLowerBound)
+          throw new BaseErrorHandler.ApiError("Bad Request", { message: "Only one lower-bound operator allowed." });
+        result[operator === ">" ? "gt" : "gte"] = value;
+        hasLowerBound = true;
+        break;
+      case "<":
+      case "<=":
+        if (hasUpperBound)
+          throw new BaseErrorHandler.ApiError("Bad Request", { message: "Only one upper-bound operator allowed." });
+        result[operator === "<" ? "lt" : "lte"] = value;
+        hasUpperBound = true;
+        break;
+    }
+  }
+  if (cleanedExpr.length > 0 && matchedStr !== cleanedExpr) {
+    throw new BaseErrorHandler.ApiError("Bad Request", { message: `Malformed input: '${expr}' is not a number` });
+  }
+  return result;
+};
+var mongodb_query_filters_default = {
+  parseComparisons,
+  addNumberFilter,
+  addRegexFilter
+};
 // node_modules/@point-hub/express-factory/lib/index.js
 class Factory {
   constructor() {
@@ -71937,6 +72006,7 @@ export {
   BaseMongoServerError,
   BaseMongoErrorHandler,
   BaseMongoDBQuerystring,
+  mongodb_query_filters_default as BaseMongoDBQueryFilters,
   BaseMongoDBHelper,
   BaseMongoDBConnection,
   Factory as BaseFactory,

package/lib/src/database/mongodb/mongodb-query-filters.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Adds a case-insensitive regex filter to the filters array if a value is provided.
+ *
+ * @param filters - An array of MongoDB filter objects to be modified.
+ * @param field - The field name to apply the regex on.
+ * @param value - The string value to search for (optional). If empty or only whitespace, no filter is added.
+ */
+export declare const addRegexFilter: (filters: Record<string, unknown>[], field: string, value?: string) => void;
+/**
+ * Adds a numeric filter to the filters array based on comparison operators or a single value.
+ *
+ * Accepts expressions like `">10<20"`, `"<=15"`, `"=5"` or `"50"` (interpreted as equality).
+ *
+ * @param filters - An array of MongoDB filter objects to be modified.
+ * @param field - The field name to apply the numeric comparison on.
+ * @param value - A string representing the numeric comparison(s).
+ */
+export declare const addNumberFilter: (filters: Record<string, unknown>[], field: string, value?: string) => void;
+/**
+ * Parses a string expression into MongoDB-style numeric comparison operators.
+ *
+ * Supported formats:
+ * - `"50"` → `{ eq: 50 }`
+ * - `">10"` → `{ gt: 10 }`
+ * - `"<=15"` → `{ lte: 15 }`
+ * - `">=5<20"` → `{ gte: 5, lt: 20 }`
+ *
+ * Constraints:
+ * - Only one lower-bound (`>` or `>=`) and one upper-bound (`<` or `<=`) operator are allowed.
+ * - Throws an API error for malformed or ambiguous expressions.
+ *
+ * @param expr - A string representing numeric comparisons.
+ * @returns An object with numeric comparison constraints.
+ *
+ * @throws Will throw an API error if the input format is invalid or has duplicate bounds.
+ */
+export declare const parseComparisons: (expr: string) => {
+    gt?: number;
+    gte?: number;
+    lt?: number;
+    lte?: number;
+    eq?: number;
+};
+declare const _default: {
+    parseComparisons: (expr: string) => {
+        gt?: number;
+        gte?: number;
+        lt?: number;
+        lte?: number;
+        eq?: number;
+    };
+    addNumberFilter: (filters: Record<string, unknown>[], field: string, value?: string) => void;
+    addRegexFilter: (filters: Record<string, unknown>[], field: string, value?: string) => void;
+};
+export default _default;
+//# sourceMappingURL=mongodb-query-filters.d.ts.map

package/lib/src/database/mongodb/mongodb-query-filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodb-query-filters.d.ts","sourceRoot":"","sources":["../../../../src/database/mongodb/mongodb-query-filters.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,MAAM,EAAE,QAAQ,MAAM,SAI/F,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,MAAM,EAAE,QAAQ,MAAM,SAmBhG,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB,GAC3B,MAAM,MAAM,KACX;IACD,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;CA2CZ,CAAA;;6BAjDO,MAAM,KACX;QACD,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ;+BA/CwC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,MAAM,UAAU,MAAM;8BAfzD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,MAAM,UAAU,MAAM;;AA0GhG,wBAIC"}

package/lib/src/database/mongodb/mongodb-query-filters.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mongodb-query-filters.spec.d.ts.map

package/lib/src/database/mongodb/mongodb-query-filters.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodb-query-filters.spec.d.ts","sourceRoot":"","sources":["../../../../src/database/mongodb/mongodb-query-filters.spec.ts"],"names":[],"mappings":""}

package/lib/src/index.d.ts

@@ -27,6 +27,7 @@ export declare const BaseMongoDBQuerystring: {
     convertStringToArray: typeof import("./database/mongodb/mongodb-querystring").convertStringToArray;
     convertArrayToObject: typeof import("./database/mongodb/mongodb-querystring").convertArrayToObject;
 };
+export { default as BaseMongoDBQueryFilters } from './database/mongodb/mongodb-query-filters';
 export declare const BaseMongoServerError: typeof MongoServerError;
 export declare const BaseMongoErrorHandler: typeof MongoErrorHandler;
 export { default as BaseFactory } from '@point-hub/express-factory';

package/lib/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EACL,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,IAAI,EACJ,qBAAqB,EAErB,KAAK,cAAc,EACpB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,OAAO,6BAA6B,MAAM,+CAA+C,CAAA;AAEzF,eAAO,MAAM,OAAO,QAAqF,CAAA;AAGzG,OAAO,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACrE,eAAO,MAAM,kBAAkB,oBAAc,CAAA;AAC7C,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,eAAO,MAAM,sBAAsB,2BAAqB,CAAA;AACxD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AACtD,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAC9C,eAAO,MAAM,sBAAsB;;;;;;;;;;CAAc,CAAA;AACjD,eAAO,MAAM,oBAAoB,yBAAmB,CAAA;AACpD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AAEtD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAEnE,eAAO,MAAM,gBAAgB;;;;;;;;CAQ5B,CAAA;AAED,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,UAAU,CAAA;AAE/C,YAAY,EAAE,cAAc,EAAE,CAAA;AAC9B,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,WAAW,EACX,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,QAAQ,GACT,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EACL,QAAQ,EACR,SAAS,EACT,sBAAsB,EACtB,IAAI,EACJ,qBAAqB,EAErB,KAAK,cAAc,EACpB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,OAAO,6BAA6B,MAAM,+CAA+C,CAAA;AAEzF,eAAO,MAAM,OAAO,QAAqF,CAAA;AAGzG,OAAO,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACrE,eAAO,MAAM,kBAAkB,oBAAc,CAAA;AAC7C,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC/C,eAAO,MAAM,sBAAsB,2BAAqB,CAAA;AACxD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AACtD,eAAO,MAAM,iBAAiB,sBAAgB,CAAA;AAC9C,eAAO,MAAM,sBAAsB;;;;;;;;;;CAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,0CAA0C,CAAA;AAC7F,eAAO,MAAM,oBAAoB,yBAAmB,CAAA;AACpD,eAAO,MAAM,qBAAqB,0BAAoB,CAAA;AAEtD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAEnE,eAAO,MAAM,gBAAgB;;;;;;;;CAQ5B,CAAA;AAED,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,UAAU,CAAA;AAE/C,YAAY,EAAE,cAAc,EAAE,CAAA;AAC9B,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,WAAW,EACX,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,QAAQ,GACT,MAAM,oBAAoB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@point-hub/papi",
-  "version": "0.5.15",
+  "version": "0.5.16",
   "description": "Point API Framework",
   "type": "module",
   "main": "lib/index.js",