@qrvey/filters 0.0.44 → 0.1.0

package/dist/resources/filter-visual.resources.d.ts

@@ -1,77 +1,27 @@
 import { IFormulaType } from "@qrvey/utils";
 import { IFilterScope } from "./filter-scopes.resources";
 import { IFilter } from "./filters.resources";
-/**
- * Structure for the visual filters
- */
 export interface IFilterVisual {
-    /**
-     * The collection of scopes
-     */
     scopes: IFilterVisualScope[];
 }
 interface IFilterVisualGeneral {
-    /**
-     * Flag to collapse
-     */
     collapsed: boolean;
 }
-/**
- * Structure for the visual filter scopes
- */
 export interface IFilterVisualScope extends IFilterVisualGeneral {
-    /**
-     * An alias for this scope
-     */
     label?: string;
-    /**
-     * Collection of datasets for this scope
-     */
     datasets: IFilterVisualDataset[];
-    /**
-     * The Scope type
-     */
     scope: IFilterScope;
-    /**
-     * The scope ID
-     */
     id?: string;
 }
-/**
- * Structure for the visual filter datasets
- */
 export interface IFilterVisualDataset extends IFilterVisualGeneral {
-    /**
-     * Collection of filters for this dataset
-     */
     filters: IFilterUI[];
-    /**
-     * Dataset ID
-     */
     id: string;
-    /**
-     * Dataset Label
-     */
     label: string;
 }
-/**
- * Structure for the visual filter items
- * Condenses all filter information including dataset and scopes
- */
 export interface IFilterUI extends IFilter {
-    /**
-     * The column Label
-     */
     columnLabel: string;
-    /**
-     * Dataset Label
-     */
     datasetLabel: string;
-    /**
-     * The Formula Type
-     */
     formulaType?: IFormulaType;
 }
 export declare const DEFAULT_UI_FILTER: IFilterUI;
 export {};
-//# sourceMappingURL=filter-visual.resources.d.ts.map

package/dist/resources/filters.resources.d.ts

@@ -11,148 +11,51 @@ export type IFilterType = FILTER_TYPE;
 export type IFilterTypeByValidator = {
     [key in IFilterValidator]: IFilterType;
 };
-/**
- * The filter structure
- */
 export interface IFilter {
-    /**
-     * The aggregate type for the column
-     */
     aggregateType?: IAggregateType;
-    /**
-     * Flag to collapse the filter
-     */
     collapsed: boolean;
-    /**
-     * The column ID
-     */
     columnId: string;
-    /**
-     * The column Type
-     */
     columnType: IColumnType;
-    /**
-     * Custom label for this filter
-     */
     customLabel?: string;
-    /**
-     * Dataset ID
-     */
     datasetId: string;
-    /**
-     * Flag to allow deleting filter
-     */
     deletable: boolean;
-    /**
-     * Flag to display the filter.
-     * Filters are applied anyway.
-     */
     displayed: boolean;
-    /**
-     * Flag to allow editing filter
-     */
     editable: boolean;
-    /**
-     * Flag to apply the filters
-     */
     enabled: boolean;
-    /**
-     * Flag to allow enabling filter
-     */
     enableable: boolean;
-    /**
-     * More information for this filter
-     */
     extras?: Record<string, unknown>;
-    /**
-     * Optional property for the formula type
-     */
-    formulaType?: IFormulaType;
-    /**
-     * Index of the selected Lookup display.
-     * It is mandatory for Lookup column type.
-     */
     lookupDisplayIndex?: number;
-    /**
-     * Grouping types. Related property for some columns (Date group|Complex Data types)
-     */
     grouping?: IFilterGrouping;
-    /**
-     * A custom icon for the filter
-     */
     icon?: string;
-    /**
-     * A custom tooltip for the filter icon
-     */
     iconTooltip?: string;
-    /**
-     * The Filter ID
-     */
     id: string;
-    /**
-     * Related operator for this and the next filter. i.e: F1 AND F2
-     */
     operator: IFilterOperator;
-    /**
-     * Flag to determine the complete selection of values
-     */
     selectAll?: boolean;
-    /**
-     * The Scope type
-     */
     scope: IFilterScope;
-    /**
-     * The scope ID
-     */
     scopeId?: string;
-    /**
-     * Validation Type to operate the filter values
-     */
     validator: IFilterValidator;
-    /**
-     * Collection of Values.
-     * Depending on the selected validator it changes.
-     * An activated Select All could recieve an empty or undefined values
-     */
+    formulaType?: IFormulaType;
     values?: IFilterValue[];
 }
-/**
- * The structure for the filter version and its version
- */
 export interface IFilterVersion<TVersionNumber extends IFilterVersionNumber = IFilterVersionNumber> {
     version: TVersionNumber;
     filters?: IFilterVersionMap[TVersionNumber];
     settings?: IFilterPanelInteractiveTable;
 }
-/**
- * Type for the Filter version
- */
 export type IFilterVersionNumber = FILTER_VERSION_TYPE;
-/**
- * Enumeration for the Filter version types
- */
 export declare enum FILTER_VERSION_TYPE {
     LOGIC = "LOGIC",
     UI_2 = "UI_2",
     V3 = "V3",
     UI_3 = "UI_3"
 }
-/**
- * Mapping for the Filter version and its structure
- */
 interface IFilterVersionMap {
     [FILTER_VERSION_TYPE.LOGIC]: IFilterLogic[];
     [FILTER_VERSION_TYPE.UI_2]: IFUData;
     [FILTER_VERSION_TYPE.V3]: IFilter[];
     [FILTER_VERSION_TYPE.UI_3]: IFilterVisual;
 }
-/**
- * The Default Filter object
- */
 export declare const DEFAULT_FILTER: IFilter;
-/**
- * Enumeration for the filter type
- */
 export declare enum FILTER_TYPE {
     REGULAR = "REGULAR",
     RANGE = "RANGE",
@@ -160,9 +63,5 @@ export declare enum FILTER_TYPE {
     RANKING = "RANKING",
     NULL = "NULL"
 }
-/**
- *
- */
 export declare const FILTER_TYPE_BY_VALIDATOR: IFilterTypeByValidator;
 export {};
-//# sourceMappingURL=filters.resources.d.ts.map

package/dist/resources/filters.resources.js

@@ -2,9 +2,6 @@ import { COLUMN, } from "@qrvey/utils";
 import { FILTER_OPERATOR } from "./filter-operators.resources";
 import { FILTER_SCOPE } from "./filter-scopes.resources";
 import { FILTER_VALIDATOR, } from "./filter-validators.resources";
-/**
- * Enumeration for the Filter version types
- */
 export var FILTER_VERSION_TYPE;
 (function (FILTER_VERSION_TYPE) {
     FILTER_VERSION_TYPE["LOGIC"] = "LOGIC";
@@ -12,9 +9,6 @@ export var FILTER_VERSION_TYPE;
     FILTER_VERSION_TYPE["V3"] = "V3";
     FILTER_VERSION_TYPE["UI_3"] = "UI_3";
 })(FILTER_VERSION_TYPE || (FILTER_VERSION_TYPE = {}));
-/**
- * The Default Filter object
- */
 export const DEFAULT_FILTER = {
     aggregateType: undefined,
     collapsed: true,
@@ -40,9 +34,6 @@ export const DEFAULT_FILTER = {
     validator: FILTER_VALIDATOR.EQUALS,
     values: [],
 };
-/**
- * Enumeration for the filter type
- */
 export var FILTER_TYPE;
 (function (FILTER_TYPE) {
     FILTER_TYPE["REGULAR"] = "REGULAR";
@@ -51,9 +42,6 @@ export var FILTER_TYPE;
     FILTER_TYPE["RANKING"] = "RANKING";
     FILTER_TYPE["NULL"] = "NULL";
 })(FILTER_TYPE || (FILTER_TYPE = {}));
-/**
- *
- */
 export const FILTER_TYPE_BY_VALIDATOR = {
     [FILTER_VALIDATOR.AFTER]: FILTER_TYPE.RANGE,
     [FILTER_VALIDATOR.AFTER_ON]: FILTER_TYPE.RANGE,

package/dist/resources/index.d.ts

@@ -6,6 +6,6 @@ export * from "./filter-panel.interfaces";
 export * from "./filter-scopes.resources";
 export * from "./filter-validators.resources";
 export * from "./filter-values.resources";
+export * from "./filter-verbose.resources";
 export * from "./filter-visual.resources";
 export * from "./filters.resources";
-//# sourceMappingURL=index.d.ts.map

package/dist/resources/index.js

@@ -6,5 +6,6 @@ export * from "./filter-panel.interfaces";
 export * from "./filter-scopes.resources";
 export * from "./filter-validators.resources";
 export * from "./filter-values.resources";
+export * from "./filter-verbose.resources";
 export * from "./filter-visual.resources";
 export * from "./filters.resources";

package/package.json

@@ -1,62 +1,73 @@
 {
   "name": "@qrvey/filters",
-  "version": "0.0.44",
+  "version": "0.1.0",
   "description": "Helpers and logic for Filtering Data in Qrvey app",
-  "main": "dist/index.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/index.js",
   "engines": {
     "node": ">=20"
   },
   "exports": {
-    "import": "./dist/index.js",
-    "require": "./dist/cjs/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "require": "./dist/cjs/*.js"
+    }
   },
   "devDependencies": {
-    "@commitlint/cli": "19.3.0",
-    "@commitlint/config-conventional": "19.2.2",
-    "@types/jest": "29.5.12",
-    "@typescript-eslint/eslint-plugin": "7.7.1",
-    "@typescript-eslint/parser": "7.7.1",
     "auto-changelog": "2.4.0",
-    "commitizen": "4.3.0",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-import-resolver-typescript": "3.6.1",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jsdoc": "48.2.3",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-sonarjs": "0.25.1",
-    "husky": "9.0.11",
-    "jest": "29.7.0",
-    "jest-environment-jsdom": "29.7.0",
-    "lint-staged": "15.2.2",
-    "np": "10.1.0",
-    "prettier": "3.2.5",
-    "ts-jest": "29.1.2",
-    "typescript": "5.4.5"
+    "@commitlint/cli": "20.5.0",
+    "@commitlint/config-conventional": "20.5.0",
+    "@eslint/compat": "2.0.5",
+    "@eslint/eslintrc": "3.3.5",
+    "@eslint/js": "10.0.1",
+    "@types/jest": "30.0.0",
+    "@typescript-eslint/eslint-plugin": "8.58.2",
+    "@typescript-eslint/parser": "8.58.2",
+    "eslint": "10.2.0",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-plugin-import-x": "4.16.2",
+    "eslint-plugin-jsdoc": "62.9.0",
+    "eslint-plugin-prettier": "5.5.5",
+    "eslint-plugin-tree-shaking": "1.12.2",
+    "husky": "9.1.7",
+    "jest": "30.3.0",
+    "jest-environment-jsdom": "30.3.0",
+    "lint-staged": "16.4.0",
+    "prettier": "3.8.2",
+    "ts-jest": "29.4.9",
+    "tsc-files": "1.1.4",
+    "typedoc": "0.28.19",
+    "typedoc-plugin-markdown": "4.11.0",
+    "typescript": "6.0.2"
   },
   "dependencies": {
-    "@qrvey/utils": "1.16.1-6",
-    "dayjs": "1.11.10"
+    "@qrvey/utils": "1.17.0-3",
+    "dayjs": "1.11.20",
+    "tslib": "2.8.1"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.json && tsc -m commonjs --outDir dist/cjs --moduleResolution node",
-    "build.clean": "node ./scripts/clean-build",
-    "commit": "cz",
-    "lint": "eslint . --quiet --exit-on-fatal-error --ext .ts,.js",
-    "lint.dev": "eslint . --debug --ext .ts,.tsx",
-    "np": "np",
-    "prepare": "husky install",
-    "publishing": "node ./scripts/clean-build && np $npm_config_np_new_version --any-branch --tag=$npm_config_np_tag",
-    "publishing.win": "node ./scripts/clean-build && np %npm_config_np_new_version% --any-branch --tag=%npm_config_np_tag%",
+    "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.cjs.json",
+    "build.clean": "node ./scripts/install-repro && node ./scripts/clean-build",
+    "build.clean.all": "npm run install.clean.all && node ./scripts/clean-build",
+    "install.clean.all": "node ./scripts/clean-install",
+    "compodoc": "typedoc && node ./scripts/inject-readme-modules.js",
+    "compodoc.server": "typedoc --watch",
+    "lint": "eslint \"{src,tests}/**/*.ts\" --quiet --exit-on-fatal-error",
+    "lint.warnings": "eslint \"{src,tests}/**/*.ts\" --exit-on-fatal-error",
+    "lint.dev": "eslint \"{src,tests}/**/*.ts\" --debug",
+    "prepare": "husky",
     "test": "jest test --verbose",
     "test.coverage": "jest test --collect-coverage",
     "test.watch": "jest test --watch",
-    "version": "auto-changelog -p && git add CHANGELOG.md"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+    "version": "npm run compodoc && node ./scripts/sync-readme-version.js && auto-changelog -p && git add CHANGELOG.md README.md"
   },
   "keywords": [
     "qrvey",
@@ -64,8 +75,12 @@
   ],
   "author": "Qrvey Inc",
   "license": "MIT",
-  "types": "dist/index.d.ts",
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "sideEffects": false,
+  "types": "dist/index.d.ts"
 }

package/.eslintignore

@@ -1,6 +0,0 @@
-node_modules
-dist
-**/*.js
-**/*.cjs
-
-src/typescript/DeepPartial.ts

package/.eslintrc.json

@@ -1,122 +0,0 @@
-{
-  "root": true,
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "./tsconfig.eslint.json"
-  },
-  "plugins": ["import", "@typescript-eslint", "prettier", "sonarjs", "jsdoc"],
-  "env": {
-    "browser": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
-    "plugin:prettier/recommended",
-    "plugin:sonarjs/recommended",
-    "plugin:jsdoc/recommended-typescript"
-  ],
-  "rules": {
-    "class-methods-use-this": "off",
-    "default-param-last": "off",
-    "dot-notation": "warn",
-    "eqeqeq": ["error", "smart"],
-    "no-array-constructor": "off",
-    "no-else-return": "error",
-    "no-empty-function": "off",
-    "no-multi-assign": ["error", { "ignoreNonDeclaration": true }],
-    "no-unneeded-ternary": "warn",
-    "no-nested-ternary": "error",
-    "no-new-func": "error",
-    "no-new-object": "error",
-    "no-new-wrappers": "error",
-    "no-param-reassign": "error",
-    "no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
-    "no-shadow": "off",
-    "no-unused-expressions": "off",
-    "no-unused-vars": "off",
-    "no-useless-constructor": "off",
-    "no-useless-escape": "warn",
-    "no-var": "error",
-    "object-shorthand": "warn",
-    "prefer-object-spread": "warn",
-    "prefer-const": "error",
-    "prefer-rest-params": "error",
-    "prefer-spread": "warn",
-    "prefer-template": "warn",
-    "require-await": "off",
-    "spaced-comment": "warn",
-    "@typescript-eslint/default-param-last": ["error"],
-    "@typescript-eslint/no-array-constructor": ["error"],
-    "@typescript-eslint/no-explicit-any": "error",
-    "@typescript-eslint/no-inferrable-types": "warn",
-    "@typescript-eslint/no-shadow": "error",
-    "@typescript-eslint/no-this-alias": [
-      "error",
-      { "allowedNames": ["self", "ctx"] }
-    ],
-    "@typescript-eslint/no-unused-expressions": [
-      "error",
-      { "allowShortCircuit": true, "allowTernary": true }
-    ],
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      { "argsIgnorePattern": "^_" }
-    ],
-    "@typescript-eslint/no-useless-constructor": ["error"],
-    "@typescript-eslint/no-var-requires": ["error"],
-    "@typescript-eslint/explicit-function-return-type": "warn",
-
-    "import/namespace": [2, { "allowComputed": true }],
-    "sort-imports": [
-      "warn",
-      {
-        "ignoreCase": true,
-        "ignoreDeclarationSort": true
-      }
-    ],
-    "import/order": [
-      "warn",
-      {
-        "groups": [["external", "builtin"], "internal", ["sibling"]],
-        "pathGroups": [
-          {
-            "pattern": "stencil",
-            "group": "external",
-            "position": "before"
-          },
-          {
-            "pattern": "@/components/**",
-            "group": "internal"
-          }
-        ],
-        "pathGroupsExcludedImportTypes": ["internal"],
-        "newlines-between": "always",
-        "alphabetize": {
-          "order": "asc",
-          "caseInsensitive": true
-        }
-      }
-    ],
-
-    "sonarjs/cognitive-complexity": ["warn"],
-    "sonarjs/no-duplicate-string": ["warn"],
-
-    "prettier/prettier": ["warn", { "endOfLine": "auto" }],
-
-    "jsdoc/require-jsdoc": [
-      "warn",
-      {
-        "require": {
-          "ClassDeclaration": true,
-          "ClassExpression": true,
-          "FunctionDeclaration": true,
-          "FunctionExpression": true,
-          "MethodDefinition": true
-        }
-      }
-    ]
-  }
-}

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx --no-install lint-staged

package/.lintstagedrc

@@ -1,7 +0,0 @@
-{
-  "*": "prettier --ignore-unknown --write",
-  "*.ts": [
-    "bash -c 'tsc --skipLibCheck --noEmit'",
-    "eslint --quiet --exit-on-fatal-error --fix"
-  ]
-}

package/.prettierignore

@@ -1,6 +0,0 @@
-.git
-.husky
-dist
-documentation
-node_modules
-README.md

package/.prettierrc.json

@@ -1 +0,0 @@
-{}