@produce8/p8-cube-helper NPM

p8-cube-helper

Helper package that operates as a wrapper for Produce8 CUBE API.

Supported Functionality

This package currently supports:

Querying of Top Apps Reports.

Useful Interfaces

CubeTimeDimensionGranularity exposes the time dimension granularity support for CUBE API.

export enum CubeTimeDimensionGranularity {
  Day = 'day',
  Week = 'week',
}

ICubeQueryHelper exposes the entry point method for querying the CUBE API.

export interface ICubeQueryHelper {
getTopAppsReport(
    params: {
      startDate: string;
      endDate: string;
      timezone: string;
      granularity?: CubeTimeDimensionGranularity;
    },
    config: { token: string }
  ): Promise<TopAppsReportDto[]>;

  getTeamAppMetrics(
    params: {
      startDate: string;
      endDate: string;
      timezone: string;
      teamId: string;
      appId: string;
      frequency: CubeTimeDimensionGranularity | Weekdays;
    },
    config: { token: string }
  ): Promise<TeamAppMetricsDto>;

  getTeamTimeSeriesAppMetrics(
    params: {
      startDate: string;
      endDate: string;
      timezone: string;
      teamId: string;
      appId: string;
      frequency: CubeTimeDimensionGranularity | Weekdays;
      userIds?: string[];
    },
    config: {
      token: string;
    }
  ): Promise<TeamTimeSeriesAppMetricsDto>;
}

TopAppsReportDto exposes the fields and data types of the response object to the client.

export interface TopAppsReportDto {
  appId: string;
  totalDuration: string;
  averageDuration: string;
  count: number;
  name: string;
  logoUrl?: string;
  displayColor?: string;
  totalDurationVsAvgDurationPercentage: string;
}

Getting started

npm install @produce8/p8-cube-helper or yarn add @produce8/p8-cube-helper

index.ts

import jwt from 'jsonwebtoken'
import CubeQueryHelper from '@produce8/p8-cube-helper'

const cubeQueryHelper = new CubeQueryHelper({
    endpoint: string, // [CUBE_REST_ENDPOINT],
    debug?: boolean //[Default: false] this can be set to true to enable logging for debugging.
});

const token = jwt.sign({userId: string, accountId: string}, CUBE_API_SECRET, {expiresIn: "30m"});

const topAppsReport = await cubeQueryHelper.getTopAppsReport(
    {
        startDate: '2023-05-29',
        endDate: '2023-05-29',
        timezone: 'America/Vancouver',
    },
    {
        token
    }
);

@cubejs-client/core @produce8/pegasus @sentry/browser class-transformer class-validator dayjs

@everything-registry/sub-chunk-739

4 days ago

6 days ago

18 days ago

21 days ago

22 days ago

25 days ago

25 days ago

25 days ago

26 days ago

26 days ago

26 days ago

26 days ago

26 days ago

27 days ago

27 days ago

27 days ago

28 days ago

28 days ago

28 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

10 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

6 months ago

6 months ago

7 months ago

10 months ago

7 months ago

10 months ago

7 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

9 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

9 months ago

9 months ago

9 months ago

8 months ago

9 months ago

9 months ago

10 months ago

7 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

9 months ago

6 months ago

9 months ago

9 months ago

11 months ago

7 months ago

11 months ago

7 months ago

11 months ago

7 months ago

10 months ago

10 months ago

10 months ago

9 months ago

9 months ago

8 months ago

9 months ago

8 months ago

9 months ago

8 months ago

9 months ago

8 months ago

9 months ago

8 months ago

8 months ago

7 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

6 months ago

7 months ago

6 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago