@crystaldesign/diva-utils 26.2.0-beta.3 → 26.2.0-beta.30

package/build/cjs/index.js

@@ -1525,6 +1525,97 @@ var UtmContent = /*#__PURE__*/function (UtmContent) {
   return UtmContent;
 }({});
 
+function parseFilterParam(param) {
+  var query = {
+    entries: []
+  };
+  if (param.startsWith('[') && param.endsWith(']')) {
+    var _query$entries;
+    //it contains multiple, remove brackets and split it up
+    (_query$entries = query.entries).push.apply(_query$entries, _toConsumableArray__default["default"](parseList(param.substring(1, param.length - 1))));
+  } else {
+    query.entries.push(parseFilterField(param));
+  }
+  return query;
+}
+function parseList(param) {
+  if (param.includes('[')) {
+    return param.split(/(?<=]),|,(?=\+?\[)/g).flatMap(function (s) {
+      //split at every comma, which is before or after a group
+      if (s.startsWith('+[')) {
+        return parseOrGroup(s);
+      } else if (s.startsWith('[')) {
+        return parseFieldList(s.substring(1, s.length - 1));
+      } else {
+        return parseFieldList(s);
+      }
+    });
+  } else {
+    return parseFieldList(param);
+  }
+}
+function parseFieldList(param) {
+  return param.split(/(?<=}),/g) //split at every comma, which is between curly brackets (get Filterfields)
+  .map(parseFilterField);
+}
+function parseOrGroup(group) {
+  var filterGroup = {
+    entries: [],
+    or: true,
+    type: 'group'
+  };
+  if (group.startsWith('+[') && group.endsWith(']')) {
+    filterGroup.entries = parseFieldList(group.replace(/\+\[|\]/g, '')); //remove encloseing brackets
+    return filterGroup;
+  }
+  throw new Error('Wrong format: Or groups have to be in the form of "+[{<field>,<op>,<value>},...]"');
+}
+function parseFilterField(filter) {
+  if (filter.startsWith('{') && filter.endsWith('}')) {
+    var split = filter.replace(/[{}]/g, '') // Remove curly braces
+    .split(/,(?=(?:[^']*'[^']*')*[^']*$)/g); // Split on commas outside of single quotes
+    // Explanation of the regex:
+    //  - , matches the comma.
+    //  - (?=...) is a positive lookahead to ensure the next condition is met.
+    //  - (?:[^']*'[^']*')* matches zero or more pairs of single-quoted sections (to ensure commas inside quotes are ignored).
+    //  - [^']*$ ensures that we are splitting only if the comma is outside any single-quoted sections (i.e., we are not inside quotes at the time of the split).
+
+    if (split.length >= 3 && split[1] == 'in') {
+      return {
+        field: split[0],
+        operator: split[1],
+        value: split.slice(2).map(parseFieldValue)
+      };
+    } else if (split.length == 3) {
+      var field = {
+        field: split[0],
+        operator: split[1],
+        value: parseFieldValue(split[2])
+      };
+      return field;
+    } else if (split.length == 2 && ['isnotnull', 'isnull', 'isnotempty', 'isempty'].includes(split[1])) {
+      var _field = {
+        field: split[0],
+        operator: split[1]
+      };
+      return _field;
+    }
+  }
+  throw new Error('Wrong format: Filter fields have to be in the form of "{<field>,<op>,<value>}"');
+}
+function parseFieldValue(value) {
+  if (value == 'true' || value == 'false') {
+    return value === 'true' ? true : false;
+  }
+  if (!isNaN(value)) {
+    return Number(value);
+  }
+  if (value.startsWith("'") && value.endsWith("'") || value.startsWith('"') && value.endsWith('"')) {
+    return value.substring(1, value.length - 1);
+  }
+  return value;
+}
+
 exports.DivaError = DivaError;
 exports.UTMUtils = UTMUtils;
 exports.UtmCampaign = UtmCampaign;
@@ -1534,3 +1625,4 @@ exports.UtmSource = UtmSource;
 exports["default"] = DivaUtils$1;
 exports.md5 = md5;
 exports.nanoid = nanoid;
+exports.parseFilterParam = parseFilterParam;

package/build/esm/index.js

@@ -1506,4 +1506,95 @@ var UtmContent = /*#__PURE__*/function (UtmContent) {
   return UtmContent;
 }({});
 
-export { DivaError, UTMUtils, UtmCampaign, UtmContent, UtmMedium, UtmSource, DivaUtils$1 as default, md5, nanoid };
+function parseFilterParam(param) {
+  var query = {
+    entries: []
+  };
+  if (param.startsWith('[') && param.endsWith(']')) {
+    var _query$entries;
+    //it contains multiple, remove brackets and split it up
+    (_query$entries = query.entries).push.apply(_query$entries, _toConsumableArray(parseList(param.substring(1, param.length - 1))));
+  } else {
+    query.entries.push(parseFilterField(param));
+  }
+  return query;
+}
+function parseList(param) {
+  if (param.includes('[')) {
+    return param.split(/(?<=]),|,(?=\+?\[)/g).flatMap(function (s) {
+      //split at every comma, which is before or after a group
+      if (s.startsWith('+[')) {
+        return parseOrGroup(s);
+      } else if (s.startsWith('[')) {
+        return parseFieldList(s.substring(1, s.length - 1));
+      } else {
+        return parseFieldList(s);
+      }
+    });
+  } else {
+    return parseFieldList(param);
+  }
+}
+function parseFieldList(param) {
+  return param.split(/(?<=}),/g) //split at every comma, which is between curly brackets (get Filterfields)
+  .map(parseFilterField);
+}
+function parseOrGroup(group) {
+  var filterGroup = {
+    entries: [],
+    or: true,
+    type: 'group'
+  };
+  if (group.startsWith('+[') && group.endsWith(']')) {
+    filterGroup.entries = parseFieldList(group.replace(/\+\[|\]/g, '')); //remove encloseing brackets
+    return filterGroup;
+  }
+  throw new Error('Wrong format: Or groups have to be in the form of "+[{<field>,<op>,<value>},...]"');
+}
+function parseFilterField(filter) {
+  if (filter.startsWith('{') && filter.endsWith('}')) {
+    var split = filter.replace(/[{}]/g, '') // Remove curly braces
+    .split(/,(?=(?:[^']*'[^']*')*[^']*$)/g); // Split on commas outside of single quotes
+    // Explanation of the regex:
+    //  - , matches the comma.
+    //  - (?=...) is a positive lookahead to ensure the next condition is met.
+    //  - (?:[^']*'[^']*')* matches zero or more pairs of single-quoted sections (to ensure commas inside quotes are ignored).
+    //  - [^']*$ ensures that we are splitting only if the comma is outside any single-quoted sections (i.e., we are not inside quotes at the time of the split).
+
+    if (split.length >= 3 && split[1] == 'in') {
+      return {
+        field: split[0],
+        operator: split[1],
+        value: split.slice(2).map(parseFieldValue)
+      };
+    } else if (split.length == 3) {
+      var field = {
+        field: split[0],
+        operator: split[1],
+        value: parseFieldValue(split[2])
+      };
+      return field;
+    } else if (split.length == 2 && ['isnotnull', 'isnull', 'isnotempty', 'isempty'].includes(split[1])) {
+      var _field = {
+        field: split[0],
+        operator: split[1]
+      };
+      return _field;
+    }
+  }
+  throw new Error('Wrong format: Filter fields have to be in the form of "{<field>,<op>,<value>}"');
+}
+function parseFieldValue(value) {
+  if (value == 'true' || value == 'false') {
+    return value === 'true' ? true : false;
+  }
+  if (!isNaN(value)) {
+    return Number(value);
+  }
+  if (value.startsWith("'") && value.endsWith("'") || value.startsWith('"') && value.endsWith('"')) {
+    return value.substring(1, value.length - 1);
+  }
+  return value;
+}
+
+export { DivaError, UTMUtils, UtmCampaign, UtmContent, UtmMedium, UtmSource, DivaUtils$1 as default, md5, nanoid, parseFilterParam };

package/build/types/utils/src/index.d.ts

@@ -9,6 +9,8 @@ export * from './utils/nanoid';
 export { DivaError };
 export * from './utils/UTMUtils';
 export * from './utils/UTMUtils/types';
+export * from './utils/parseFilterParam';
 export type { EventAction, EventModule, PriceFormat, ApplicationLoggerInterface, PfisterEventAction };
+export type { Query, FilterQuery, FilterField, FilterGroup, Sort, Facets, QueryResult } from './types/FilterParamTypes';
 //# sourceMappingURL=index.d.ts.map
   

package/build/types/utils/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC5F,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,eAAe,SAAS,CAAC;AAEzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AAEvC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC5F,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,eAAe,SAAS,CAAC;AAEzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,CAAC;AACtG,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC"}

package/build/types/utils/src/types/FilterParamTypes.d.ts

@@ -0,0 +1,61 @@
+export interface Query {
+    /**
+     * Limits the number of returned documents
+     *  */
+    limit?: number;
+    /**
+     * Skips a defined number of documents, used mainly for paging
+     * */
+    skip?: number;
+    /**
+     * Defines the sort order of the returned documents
+     */
+    sort?: Sort[];
+    /**
+     * Used to return only some fields of the result documents.
+     */
+    fields?: string[];
+    /**
+     * Used to filter the returned documents.
+     */
+    filter?: FilterQuery;
+    /**
+     * Used to filter the returned documents, with the faster search index
+     */
+    search?: FilterQuery;
+    queryParams?: {
+        [key: string]: string;
+    };
+}
+export type Operator = 'eq' | 'ne' | 'isnull' | 'isnotnull' | 'lt' | 'lte' | 'gt' | 'gte' | 'startswith' | 'endswith' | 'contains' | 'doesnotcontain' | 'isempty' | 'isnotempty' | 'in' | 'nin' | 'exists' | 'notexists' | 'custom';
+export interface FilterField {
+    type?: 'field';
+    field: string;
+    operator: Operator;
+    value?: number | string | boolean | string[] | object;
+}
+export interface FilterGroup {
+    type: 'group';
+    entries: FilterField[];
+    or?: boolean;
+}
+export interface FilterQuery {
+    entries: (FilterField | FilterGroup)[];
+}
+export interface Sort {
+    field: string;
+    desc?: boolean;
+}
+export interface Facets {
+    [key: string]: {
+        type: 'string' | 'number' | 'date';
+        path: string;
+        boundaries?: number[];
+        default?: string;
+    };
+}
+export interface QueryResult<T> {
+    data: Partial<T>[];
+    total: number;
+}
+//# sourceMappingURL=FilterParamTypes.d.ts.map

package/build/types/utils/src/types/FilterParamTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilterParamTypes.d.ts","sourceRoot":"","sources":["../../../../../src/types/FilterParamTypes.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB;;UAEM;IACN,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;SAEK;IACL,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,MAAM,QAAQ,GAChB,IAAI,GACJ,IAAI,GACJ,QAAQ,GACR,WAAW,GACX,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,YAAY,GACZ,UAAU,GACV,UAAU,GACV,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,IAAI,GACJ,KAAK,GACL,QAAQ,GACR,WAAW,GACX,QAAQ,CAAC;AACb,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;CACvD;AACD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,EAAE,CAAC,EAAE,OAAO,CAAC;CACd;AACD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC,EAAE,CAAC;CACxC;AACD,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,MAAM;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;QACnC,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf"}

package/build/types/utils/src/utils/parseFilterParam.d.ts

@@ -0,0 +1,3 @@
+import { FilterQuery } from '../types/FilterParamTypes';
+export declare function parseFilterParam(param: string): FilterQuery;
+//# sourceMappingURL=parseFilterParam.d.ts.map

package/build/types/utils/src/utils/parseFilterParam.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseFilterParam.d.ts","sourceRoot":"","sources":["../../../../../src/utils/parseFilterParam.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA4B,MAAM,2BAA2B,CAAC;AAElF,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAS3D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crystaldesign/diva-utils",
-  "version": "26.2.0-beta.3",
+  "version": "26.2.0-beta.30",
   "description": "",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -24,5 +24,5 @@
   "module": "build/esm/index.js",
   "types": "./build/types/utils/src/index.d.ts",
   "main": "build/cjs/index.js",
-  "gitHead": "a32c8e727d3d290307e55d6bfbe04bed1a474629"
+  "gitHead": "a316fda1fce1b951ec9a6b07bf99715b042f270b"
 }