@qrvey/utils

@qrvey/utils 1.18.17

Helper, Utils for all Qrvey Projects

Release pipelines

• Guide to run manual releases in Bitbucket: 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.

// Good: allows bundlers to remove unused exports
import { isEmpty, objectCopy } from "@qrvey/utils";

// Better for critical bundles: import only the module you need
import { formatDate } from "@qrvey/utils/format/format";

2) Avoid for optimized bundles

// Avoid in frontend apps: can pull more code into the bundle
import * as QrveyUtils from "@qrvey/utils";

3) CommonJS compatibility

For Node projects or integrations that require CommonJS:

const { isEmpty } = require("@qrvey/utils");
const { formatDate } = require("@qrvey/utils/format/format");

4) Recommendations for consumer apps

• Prefer import over require in frontend code.
• Use subpaths (@qrvey/utils/<module>) on performance-critical paths.
• Keep tree shaking enabled in your bundler (Webpack/Rollup/Vite in production mode).

---

Modules

Module	Description	Subpath import	API docs
cache-managers	Managers for caching chart, metric, model, theme, platform-config and permissions data. Provides a centralised in-memory caching layer used across Qrvey widgets.	@qrvey/utils/cache-managers/index	docs
charts	Constants, interfaces, adapters and helpers for chart types, aggregations, request adapters and chart configuration objects.	@qrvey/utils/charts/index	docs
column_format	Helpers and constants for column display formatting: string formats, date groups, duration parts, chart groups, shelf types and table types.	@qrvey/utils/column_format/index	docs
columns	Interfaces, constants and helpers for dataset column definitions, compound columns and column property descriptors.	@qrvey/utils/columns/index	docs
constants	Shared top-level constants for charts and design tokens used across the whole library.	@qrvey/utils/constants/index	docs
dates	Adapters, constants, helpers and interfaces for date parsing, formatting, grouping, validation and relative date ranges.	@qrvey/utils/dates/index	docs
elements	Helpers and interfaces for DOM element positioning, overlap detection, responsive layout and grid strategy calculations.	@qrvey/utils/elements/index	docs
filters	Adapters, classes, constants, helpers and interfaces for filter management, filter panel views, backend validators and filter settings.	@qrvey/utils/filters/index	docs
format	Utilities for number, date, file-size and duration formatting, format definitions, localization helpers and format output adapters.	@qrvey/utils/format/index	docs
formulas	Interfaces and constants for formula definitions and formula types used in Qrvey chart and panel configurations.	@qrvey/utils/formulas/index	docs
general	General-purpose utilities for arrays, objects, strings, functions and numeric operations used throughout the Qrvey platform.	@qrvey/utils/general/index	docs
globalization	i18n interfaces, label maps, helpers and a service builder (i18next) for localising Qrvey widgets and components.	@qrvey/utils/globalization/index	docs
interfaces	Shared TypeScript interfaces for charts, widget configurations, Qrvey entities, format configs, custom tokens and chart builder contracts.	@qrvey/utils/interfaces/index	docs
qrvey	Constants and interfaces specific to Qrvey app entities: app types, form types, dataset types, statuses and calculation descriptors.	@qrvey/utils/qrvey/index	docs
services	Endpoint constants, API helpers, adapters and interfaces for Qrvey backend services (charts, metrics, themes, datasets, uCharts, etc.).	@qrvey/utils/services/index	docs
stencil	Decorators and utilities for Stencil.js web components: component config helpers, ref utilities and Stencil-specific patterns.	@qrvey/utils/stencil/index	docs
themes	Constants, interfaces and helpers for theme management: CSS variable names, color utilities, RGBA/hex regex patterns and canvas theme variables.	@qrvey/utils/themes/index	docs
tokens	Utilities for working with custom design tokens: parsing, cleaning, key-extraction and box-parse helpers.	@qrvey/utils/tokens/index	docs
typescript	TypeScript utility types and decorators: DeepPartial, DeepRequired, Debounce, Throttle, ValueOf and other general-purpose type helpers.	@qrvey/utils/typescript/index	docs