@rokkit/data 1.1.18 → 1.2.0

package/dist/src/parser.d.ts

@@ -19,13 +19,38 @@
  * @returns {RegExp} - The regular expression pattern to identify search filter elements.
  */
 export function getRegex(): RegExp;
+/**
+ * A parsed filter condition.
+ *
+ * @typedef {Object} FilterObject
+ * @property {string}                  [column]  - Column to filter (undefined = search all columns)
+ * @property {string}                  operator  - Comparison operator
+ * @property {string|number|RegExp}    value     - Filter value
+ */
 /**
  * Parses a search string and extracts filters based on a predefined regular expression pattern.
  * Each filter captures column, operator, and value components. Any remaining text that
  * does not fit the pattern is considered a general search term.
  *
  * @param {string} string - The search string to parse for filters.
- * @returns {Object[]} - An array of filter objects each containing the column, operator, and value,
+ * @returns {FilterObject[]} - An array of filter objects each containing the column, operator, and value,
  *                       plus an additional object for general search if there is remaining text.
  */
-export function parseFilters(string: string): Object[];
+export function parseFilters(string: string): FilterObject[];
+/**
+ * A parsed filter condition.
+ */
+export type FilterObject = {
+    /**
+     * - Column to filter (undefined = search all columns)
+     */
+    column?: string | undefined;
+    /**
+     * - Comparison operator
+     */
+    operator: string;
+    /**
+     * - Filter value
+     */
+    value: string | number | RegExp;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/data",
-  "version": "1.1.18",
+  "version": "1.2.0",
   "description": "Contains generic data manipulation functions that can be used in various components.",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
   },
   "dependencies": {
     "@lukeed/uuid": "^2.0.1",
-    "@rokkit/core": "1.1.18",
+    "@rokkit/core": "1.2.0",
     "d3-array": "^3.2.4",
     "d3-collection": "^1.0.7",
     "ramda": "^0.32.0",

package/src/parser.js

@@ -70,13 +70,22 @@ function processValue(value, operator) {
 	return value
 }
 
+/**
+ * A parsed filter condition.
+ *
+ * @typedef {Object} FilterObject
+ * @property {string}                  [column]  - Column to filter (undefined = search all columns)
+ * @property {string}                  operator  - Comparison operator
+ * @property {string|number|RegExp}    value     - Filter value
+ */
+
 /**
  * Parses a search string and extracts filters based on a predefined regular expression pattern.
  * Each filter captures column, operator, and value components. Any remaining text that
  * does not fit the pattern is considered a general search term.
  *
  * @param {string} string - The search string to parse for filters.
- * @returns {Object[]} - An array of filter objects each containing the column, operator, and value,
+ * @returns {FilterObject[]} - An array of filter objects each containing the column, operator, and value,
  *                       plus an additional object for general search if there is remaining text.
  */
 export function parseFilters(string) {