pega-ui-list-data-apis(ClientApi)

This package offers two categories of utilities:

1. A set of utilities for performing various operations on data, including filtering, sorting, grouping, and aggregations.
2. A set of utilities for preparing the DataViews api queries.

Documentation

Api's

• fetchData(query,meta,data)

  This api is used to fetch a list of raw data rows (excluding aggregations) for a given group or at the top level when no groups from the provided data using query and meta.

• fetchUniqueColValues(query,meta,colId,data)

  This api is used to fetch the unique values for a given colId. The colId should be equal to fieldDef id for which unique values needs to be fetched.

• fetchGroupedInfo(query,meta,data)

  This api is used to fetch details for any group/sub-group for a given data. It returns labels, counts, aggregation values at each group node.

• fetchAggregatedValues(query,meta,data)

  This api is used to fetch aggregation results for a given aggregation type(sum/min/max/count) in the query

Installation

Install @pega/lists-core-utils with npm as a dependency in your project.

  npm install @pega/lists-core-utils

Development guidelines

Its a pure javascript library. You can write code in javascript.

Build

We use roll-up to build this package. Use below command to build the package.

  npm run build

Writing Tests

Jest framework is being used to for writing and running tests.Below is the standard syntax that is followed across all unit tests.

describe('A description for group of tests', () => {
  it('A description for this test', () => {
    const result = add(2, 3);
    expect(result).toBe(5);
  });
});

Executing Tests

The below command will run all the unit test present in this package.

  npm run test

Linting

Run below command to catch all the lint issues

  npm run lint

Run below command to fix common lint issues automatically

  npm run fix