@qrvey/filters 0.0.44 → 0.1.0

package/README.md

@@ -1 +1,63 @@
-# qrvey_filters
+# [@qrvey/filters](https://bitbucket.org/qrvey/qrvey_filters/wiki/Home) *0.1.0*
+
+> Helpers and logic for Filtering Data in Qrvey app
+
+## Release pipelines
+
+- Guide to run manual releases in Bitbucket: [RELEASE_PIPELINES.md](./RELEASE_PIPELINES.md)
+
+## Recommended consumption guide
+
+This package exposes **ESM + CommonJS**:
+
+- `import` (ESM) for modern bundlers and better tree shaking.
+- `require` (CommonJS) for legacy implementations.
+
+### 1) Recommended (ESM with tree shaking)
+
+Use named imports from the entrypoint or specific subpaths.
+
+```ts
+// Good: allows bundlers to remove unused exports
+import { FilterManager, FilterBuilder } from "@qrvey/filters";
+
+// Better for critical bundles: import only the module you need
+import { FilterManager } from "@qrvey/filters/classes/index";
+```
+
+### 2) Avoid for optimized bundles
+
+```ts
+// Avoid in frontend apps: can pull more code into the bundle
+import * as QrveyFilters from "@qrvey/filters";
+```
+
+### 3) CommonJS compatibility
+
+For Node projects or integrations that require CommonJS:
+
+```js
+const { FilterManager } = require("@qrvey/filters");
+const { FilterManager } = require("@qrvey/filters/classes/index");
+```
+
+### 4) Recommendations for consumer apps
+
+- Prefer `import` over `require` in frontend code.
+- Use subpaths (`@qrvey/filters/<module>`) on performance-critical paths.
+- Keep tree shaking enabled in your bundler (Webpack/Rollup/Vite in production mode).
+
+---
+
+<!-- MODULES_START -->
+
+## Modules
+
+| Module | Description | Subpath import | API docs |
+| ------ | ----------- | -------------- | -------- |
+| `classes` | Core classes: FilterBuilder, FilterManager, FilterAdapter, FilterSearcher, FilterValidation, FilterValues and FilterResources. | `@qrvey/filters/classes/index` | [docs](docs/classes/index.md) |
+| `helpers` | Stateless utility functions for filter adaptation, settings, ID generation, type resolution and condition handling. | `@qrvey/filters/helpers/index` | [docs](docs/helpers/index.md) |
+| `models` | TypeScript interfaces and types for FilterBuilder, FilterResources and FilterSearcher internals. | `@qrvey/filters/models/index` | [docs](docs/models/index.md) |
+| `resources` | Enums, constants and panel interfaces for filter functions, grouping, logic, operators, scopes, validators, values, visual options and the DEFAULT_FILTER. | `@qrvey/filters/resources/index` | [docs](docs/resources/index.md) |
+
+<!-- MODULES_END -->

package/dist/cjs/classes/FilterAdapter.js

@@ -5,72 +5,33 @@ const filter_adapt_helpers_1 = require("../helpers/filter-adapt.helpers");
 const filter_adapt_legacy_helpers_1 = require("../helpers/filter-adapt.legacy.helpers");
 const filter_adapt_logic_helpers_1 = require("../helpers/filter-adapt.logic.helpers");
 const filters_resources_1 = require("../resources/filters.resources");
-/**
- * Class to adapt the filters
- */
 class FilterAdapter {
     _filters;
     datasets;
     interactiveTable;
-    /**
-     * The Logic filters
-     */
     _logic;
-    /**
-     * The visual filters
-     */
     _visual;
-    /**
-     * The old Filter Data structure
-     */
     _legacyVisual;
-    /**
-     * Constructor
-     * @param _filters the collection of filters
-     * @param datasets the collection of datasets info
-     * @param interactiveTable table of interaction properties for each section
-     */
     constructor(_filters = [], datasets = [], interactiveTable) {
         this._filters = _filters;
         this.datasets = datasets;
         this.interactiveTable = interactiveTable;
         this.setFilters(Array.isArray(_filters) ? _filters : []);
     }
-    /**
-     *
-     */
     sync() {
         this.setVisual(this.filterToVisual());
         this.setLegacyVisual(this.filterToLegacyVisual());
         this.setLogic(this.filterToLogic());
     }
-    /**
-     * Generates a visual filter structure from the filter collection.
-     * @returns a visual Filter structure
-     */
     filterToLegacyVisual() {
         return (0, filter_adapt_legacy_helpers_1.filterToLegacyVisual)(this._filters, this.datasets, this.interactiveTable);
     }
-    /**
-     * Generates a logic filters structure from the filter collection.
-     * @returns the Logic Filters
-     */
     filterToLogic() {
         return (0, filter_adapt_logic_helpers_1.filterToLogic)(this._filters);
     }
-    /**
-     * Generates a visual filter structure from the filter collection.
-     * @returns a visual Filter structure
-     */
     filterToVisual() {
         return (0, filter_adapt_helpers_1.filterToVisual)(this._filters, this.datasets, this.interactiveTable);
     }
-    /**
-     * Generates the filter collection from the legacy filter
-     * @param legacyVisual the legacy filter
-     * @param interactiveTable the interactive table object
-     * @returns the filter collection
-     */
     static legacyVisualToFilter(legacyVisual, interactiveTable) {
         const filters = (0, filter_adapt_legacy_helpers_1.legacyVisualToFilter)(legacyVisual);
         const newInteractiveTable = (0, filter_adapt_legacy_helpers_1.legacyVisualToInteractiveTable)(legacyVisual, interactiveTable);
@@ -79,88 +40,48 @@ class FilterAdapter {
             interactiveTable: newInteractiveTable,
         };
     }
-    /**
-     * Gets the legacy filter version attribute
-     * @returns the legacy filter version
-     */
     get legacyVisual() {
         return {
             filters: this._legacyVisual,
             version: filters_resources_1.FILTER_VERSION_TYPE.UI_2,
         };
     }
-    /**
-     * Gets the filter logic version
-     * @returns the filter logic version
-     */
     get logic() {
         return {
             filters: this._logic,
             version: filters_resources_1.FILTER_VERSION_TYPE.LOGIC,
         };
     }
-    /**
-     * Gets the visual filter version
-     * @returns the visual filter version
-     */
     get visual() {
         return {
             filters: this._visual,
             version: filters_resources_1.FILTER_VERSION_TYPE.UI_3,
         };
     }
-    /**
-     * Gets the filter version 3
-     * @returns the filter version 3
-     */
     get filters() {
         return {
-            filters: this._filters ?? [],
+            filters: this._filters,
             version: filters_resources_1.FILTER_VERSION_TYPE.V3,
         };
     }
-    /**
-     * Sets the datasets atribute
-     * @param datasets the collection of dataset info
-     */
     setDatasets(datasets = []) {
         this.datasets = datasets;
         this.sync();
     }
-    /**
-     * Sets the collection of filters atribute
-     * @param filters the filters
-     */
     setFilters(filters) {
         this._filters = filters;
         this.sync();
     }
-    /**
-     * Sets the table of interactive table attribute
-     * @param interactiveTable table of interaction properties for each section
-     */
     setInteractiveTable(interactiveTable) {
         this.interactiveTable = interactiveTable;
         this.sync();
     }
-    /**
-     * Sets the filter legacy visual attribute
-     * @param legacyVisual the legacy visual filters
-     */
     setLegacyVisual(legacyVisual) {
         this._legacyVisual = legacyVisual;
     }
-    /**
-     * Sets the filter logic attribute
-     * @param logic the logic filters
-     */
     setLogic(logic) {
         this._logic = logic;
     }
-    /**
-     * Sets the filter visual attribute
-     * @param visual the visual filters
-     */
     setVisual(visual) {
         this._visual = visual;
     }