@qrvey/utils 1.6.0-7 → 1.7.0-1

package/dist/charts/adapters/RequestAdapterMetric.d.ts

@@ -0,0 +1,7 @@
+import { MetricConfig, MetricRequestPayload } from "../interfaces/IRequestAdapterMetric";
+/**
+ * It takes a metric object and returns a metric request object
+ * @param {MetricConfig} metricObj - MetricConfigData
+ * @returns A function that takes in a metricObj and returns a partial metricRequest
+ */
+export declare const makeBodyRequestMetrics: (metricObj: MetricConfig) => Partial<MetricRequestPayload>;

package/dist/charts/adapters/RequestAdapterMetric.js

@@ -0,0 +1,120 @@
+import { isEmpty } from "../../general";
+import { TIME_PERIOD, TP_CUSTOM_RANGE } from "../../interfaces";
+import { RELATIVE_OBJECT_BY_TIME_LABEL } from "../constants/REQUEST_ADAPTER";
+/**
+ * It takes a metric object and returns a metric request object
+ * @param {MetricConfig} metricObj - MetricConfigData
+ * @returns A function that takes in a metricObj and returns a partial metricRequest
+ */
+export const makeBodyRequestMetrics = (metricObj) => {
+    const body = {};
+    const data = metricObj.data;
+    body.logic = getFilterLogic(metricObj);
+    body.value = metricMakeValue(data);
+    /* Checking if the data object has a dateColumn property. If it does, it will add a period and
+      comparison property to the body object. */
+    if (isComparison(data)) {
+        body.period = metricMakeTimeData(data.dateColumn, data.timePeriod, getRangeDataPeriod(data));
+        body.comparison = metricMakeTimeData(data.dateColumn, data.comparison, getRangeDataComparison(data));
+    }
+    return body;
+};
+/**
+ * If data is truthy, return data.logic, otherwise return an empty array.
+ * @param filters - The data object that is passed to the component.
+ */
+const getFilterLogic = (filters) => (filters === null || filters === void 0 ? void 0 : filters.logic) || [];
+/**
+ * It takes a data object and returns a MetricValue object
+ * @param data - The data object that is passed to the component.
+ * @returns A metric value object
+ */
+const metricMakeValue = (data) => {
+    var _a, _b, _c;
+    return {
+        questionid: (_a = data === null || data === void 0 ? void 0 : data.value) === null || _a === void 0 ? void 0 : _a.id,
+        aggregate: (_b = data === null || data === void 0 ? void 0 : data.valueAggregate) === null || _b === void 0 ? void 0 : _b.label,
+        property: ((_c = data === null || data === void 0 ? void 0 : data.value) === null || _c === void 0 ? void 0 : _c.property) || null,
+    };
+};
+/**
+ * If data is truthy and data.dateColumn is truthy, return true, otherwise return false.
+ * @param data - The data object that is passed to the component.
+ */
+const isComparison = (data) => Boolean(data === null || data === void 0 ? void 0 : data.dateColumn);
+/**
+ * It takes a date column, time data, and a custom range config and returns a metric period or metric
+ * custom range
+ * @param dateColumn - The column that contains the date data.
+ * @param timeData - {
+ * @param {CustomRangeConfig} range - CustomRangeConfig
+ * @returns An object with the following properties:
+ *   - label
+ *   - value
+ *   - questionid
+ */
+const metricMakeTimeData = (dateColumn, timeData, range) => {
+    const relativObject = getConfigRelativeObjectBytimeLabel(timeData.label, range);
+    if (!isEmpty(relativObject))
+        return Object.assign(Object.assign({}, relativObject), { questionid: dateColumn.id });
+};
+/**
+ * Given a time label and a custom range, return a relative date config or a metric custom range.
+ * @param {TIME_PERIOD} timeLabel - TIME_PERIOD.CUSTOM_RANGE
+ * @param {CustomRangeConfig} range - CustomRangeConfig
+ * @returns A relative date config or a metric custom range
+ */
+const getConfigRelativeObjectBytimeLabel = (timeLabel, range) => {
+    if (timeLabel === TIME_PERIOD.CUSTOM_RANGE) {
+        const rangeResults = makeCustomRangeConfig(range);
+        if (!isEmpty(rangeResults))
+            return { customRange: rangeResults };
+    }
+    return RELATIVE_OBJECT_BY_TIME_LABEL[timeLabel];
+};
+/**
+ * It takes in a custom range config object and returns a custom range object
+ * @param {CustomRangeConfig} customRangeData - CustomRangeConfig
+ * @returns A function that takes in a customRangeData object and returns a customRange object.
+ */
+const makeCustomRangeConfig = (customRangeData) => {
+    const { endDate, startingDate, label } = customRangeData;
+    if (label === TP_CUSTOM_RANGE.AFTER && !isEmpty(startingDate))
+        return { gte: startingDate };
+    if (label === TP_CUSTOM_RANGE.BEFORE && !isEmpty(startingDate))
+        return { lte: startingDate };
+    if (!isEmpty(startingDate) && !isEmpty(endDate))
+        return { gte: startingDate, lte: endDate };
+};
+/**
+ * It takes in a metricData object and returns a CustomRangeConfig object
+ * @param metricData - The metric data object that is returned from the API.
+ * @returns An object with the following properties:
+ * startingDate: metricData?.timePeriodDate,
+ * endDate: metricData?.timePeriodEndDate,
+ * label: metricData?.timePeriodCustomRange?.label,
+ */
+const getRangeDataPeriod = (metricData) => {
+    var _a;
+    return {
+        startingDate: metricData === null || metricData === void 0 ? void 0 : metricData.timePeriodDate,
+        endDate: metricData === null || metricData === void 0 ? void 0 : metricData.timePeriodEndDate,
+        label: (_a = metricData === null || metricData === void 0 ? void 0 : metricData.timePeriodCustomRange) === null || _a === void 0 ? void 0 : _a.label,
+    };
+};
+/**
+ * It takes in a metricData object and returns a CustomRangeConfig object
+ * @param metricData - The metric data object that is returned from the API.
+ * @returns An object with the following properties:
+ * startingDate: metricData?.comparisonDate,
+ * endDate: metricData?.comparisonEndDate,
+ * label: metricData?.comparisonCustomRange?.label,
+ */
+const getRangeDataComparison = (metricData) => {
+    var _a;
+    return {
+        startingDate: metricData === null || metricData === void 0 ? void 0 : metricData.comparisonDate,
+        endDate: metricData === null || metricData === void 0 ? void 0 : metricData.comparisonEndDate,
+        label: (_a = metricData === null || metricData === void 0 ? void 0 : metricData.comparisonCustomRange) === null || _a === void 0 ? void 0 : _a.label,
+    };
+};

package/dist/charts/adapters/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./endpointDataValidators";
 export * from "./endpointDataGet";
 export * from "./endpointData";
+export * from "./RequestAdapterMetric";

package/dist/charts/adapters/index.js

@@ -1,3 +1,4 @@
 export * from "./endpointDataValidators";
 export * from "./endpointDataGet";
 export * from "./endpointData";
+export * from "./RequestAdapterMetric";

package/dist/charts/constants/REQUEST_ADAPTER.d.ts

@@ -0,0 +1,91 @@
+import { DATE_GROUPING_PROPERTY, DATE_GROUPING_TIME_PROPERTY, RELATIVE_CURSOR } from "../../dates";
+export declare const RELATIVE_OBJECT_BY_TIME_LABEL: {
+    THIS_SECOND: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_TIME_PROPERTY;
+    };
+    LAST_SECOND: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_TIME_PROPERTY;
+        number: number;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    THIS_MINUTE: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_TIME_PROPERTY;
+    };
+    LAST_MINUTE: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_TIME_PROPERTY;
+        number: number;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    THIS_HOUR: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_TIME_PROPERTY;
+    };
+    LAST_HOUR: {
+        cursor: RELATIVE_CURSOR;
+        number: number;
+        unit: DATE_GROUPING_TIME_PROPERTY;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    TODAY: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_PROPERTY;
+    };
+    YESTERDAY: {
+        cursor: RELATIVE_CURSOR;
+        number: number;
+        unit: DATE_GROUPING_PROPERTY;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    THIS_WEEK: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_PROPERTY;
+    };
+    LAST_WEEK: {
+        cursor: RELATIVE_CURSOR;
+        number: number;
+        unit: DATE_GROUPING_PROPERTY;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    THIS_MONTH: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_PROPERTY;
+    };
+    LAST_MONTH: {
+        cursor: RELATIVE_CURSOR;
+        number: number;
+        unit: DATE_GROUPING_PROPERTY;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    THIS_QUARTER: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_PROPERTY;
+    };
+    LAST_QUARTER: {
+        cursor: RELATIVE_CURSOR;
+        number: number;
+        unit: DATE_GROUPING_PROPERTY;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+    THIS_YEAR: {
+        cursor: RELATIVE_CURSOR;
+        unit: DATE_GROUPING_PROPERTY;
+    };
+    LAST_YEAR: {
+        cursor: RELATIVE_CURSOR;
+        number: number;
+        unit: DATE_GROUPING_PROPERTY;
+        includeCurrent: boolean;
+        isCalendarDate: boolean;
+    };
+};

package/dist/charts/constants/REQUEST_ADAPTER.js

@@ -0,0 +1,93 @@
+import { DATE_GROUPING_PROPERTY, DATE_GROUPING_TIME_PROPERTY, RELATIVE_CURSOR, } from "../../dates";
+import { TIME_PERIOD } from "../../interfaces";
+/* A constant that is used to define the time period for the metric chart. */
+export const RELATIVE_OBJECT_BY_TIME_LABEL = {
+    [TIME_PERIOD.THIS_SECOND]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_TIME_PROPERTY.SECOND,
+    },
+    [TIME_PERIOD.LAST_SECOND]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        unit: DATE_GROUPING_TIME_PROPERTY.SECOND,
+        number: 1,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.THIS_MINUTE]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_TIME_PROPERTY.MINUTE,
+    },
+    [TIME_PERIOD.LAST_MINUTE]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        unit: DATE_GROUPING_TIME_PROPERTY.MINUTE,
+        number: 1,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.THIS_HOUR]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_TIME_PROPERTY.HOUR,
+    },
+    [TIME_PERIOD.LAST_HOUR]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        number: 1,
+        unit: DATE_GROUPING_TIME_PROPERTY.HOUR,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.TODAY]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_PROPERTY.DAY,
+    },
+    [TIME_PERIOD.YESTERDAY]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        number: 1,
+        unit: DATE_GROUPING_PROPERTY.DAY,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.THIS_WEEK]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_PROPERTY.WEEK,
+    },
+    [TIME_PERIOD.LAST_WEEK]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        number: 1,
+        unit: DATE_GROUPING_PROPERTY.WEEK,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.THIS_MONTH]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_PROPERTY.MONTH,
+    },
+    [TIME_PERIOD.LAST_MONTH]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        number: 1,
+        unit: DATE_GROUPING_PROPERTY.MONTH,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.THIS_QUARTER]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_PROPERTY.QUARTER,
+    },
+    [TIME_PERIOD.LAST_QUARTER]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        number: 1,
+        unit: DATE_GROUPING_PROPERTY.QUARTER,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+    [TIME_PERIOD.THIS_YEAR]: {
+        cursor: RELATIVE_CURSOR.THIS,
+        unit: DATE_GROUPING_PROPERTY.YEAR,
+    },
+    [TIME_PERIOD.LAST_YEAR]: {
+        cursor: RELATIVE_CURSOR.LAST,
+        number: 1,
+        unit: DATE_GROUPING_PROPERTY.YEAR,
+        includeCurrent: false,
+        isCalendarDate: true,
+    },
+};

package/dist/charts/constants/index.d.ts

@@ -4,3 +4,4 @@ export * from "./AGGREGATE_INFO_LIST";
 export * from "./AGGREGATE_INFO";
 export * from "./AGGREGATE_LABEL";
 export * from "./AGGREGATE";
+export * from "./REQUEST_ADAPTER";

package/dist/charts/constants/index.js

@@ -4,3 +4,4 @@ export * from "./AGGREGATE_INFO_LIST";
 export * from "./AGGREGATE_INFO";
 export * from "./AGGREGATE_LABEL";
 export * from "./AGGREGATE";
+export * from "./REQUEST_ADAPTER";

package/dist/charts/interfaces/IRequestAdapterMetric.d.ts

@@ -0,0 +1,124 @@
+import { IBColumn } from "../../columns";
+import { IDateGroupingProperty, RelativeCursor } from "../../dates";
+import { IFBLogic } from "../../filters";
+import { TimePeriod, TP_CUSTOM_RANGE } from "../../interfaces";
+import { AGGREGATE_LABEL } from "../constants";
+export interface MetricRequestPayload {
+    logic: IFBLogic[];
+    value: MetricValue;
+    period?: MetricPeriod | MetricCustomRange;
+    comparison?: MetricComparison | MetricCustomRange;
+}
+/**
+ * A metric value is an object with an aggregate label, a question id, and an optional property.
+ * @property {AGGREGATE_LABEL} aggregate - The aggregate label to use.
+ * @property {string} questionid - The question ID of the question you want to get the metric for.
+ * @property {string | null} property - The property of the question that you want to aggregate. For
+ * example, if you want to aggregate the number of times a question was answered, you would use the
+ * property "answered".
+ */
+export declare type MetricValue = {
+    aggregate: AGGREGATE_LABEL;
+    questionid: string;
+    property?: string | null;
+};
+/**
+ * A `RelativeDateConfig` is an object with a `questionid` property, a `cursor` property, an optional
+ * `number` property, a `unit` property, an optional `includeCurrent` property, and an optional
+ * `isCalendarDate` property.
+ * @property {string} questionid - The question id of the question that you want to filter on.
+ * @property {RelativeCursor} cursor - The cursor is the date that the relative date is based on.  It
+ * can be one of the following:
+ * @property {number} number - The number of units to go back.
+ * @property {IDateGroupingProperty} unit - The unit of time to use for the relative date. This can be
+ * one of the following:
+ * @property {boolean} includeCurrent - If true, the current date is included in the range.
+ * @property {boolean} isCalendarDate - If true, the date is a calendar date, otherwise it's a relative
+ * date.
+ */
+export declare type RelativeDateConfig = {
+    questionid: string;
+    cursor: RelativeCursor;
+    number?: number;
+    unit: IDateGroupingProperty;
+    includeCurrent?: boolean;
+    isCalendarDate?: boolean;
+};
+/**
+ * `MetricCustomRange` is a type that has a property called `customRange` that is of type
+ * `CustomRange`.
+ * @property {CustomRange} customRange - The custom range to use for the metric.
+ */
+export declare type MetricCustomRange = {
+    customRange: CustomRange;
+};
+/**
+ * `CustomRangeConfig` is an object with optional properties `startingDate`, `endDate`, and `label`.
+ * @property {string} startingDate - The starting date of the custom range.
+ * @property {string} endDate - The end date of the custom range.
+ * @property {TP_CUSTOM_RANGE} label - The label for the custom range.
+ */
+export declare type CustomRangeConfig = {
+    startingDate?: string;
+    endDate?: string;
+    label?: TP_CUSTOM_RANGE;
+};
+/**
+ * CustomRange is an object with optional gte and lte properties, both of which are strings.
+ * @property {string} gte - Greater than or equal to
+ * @property {string} lte - Less than or equal to
+ */
+export declare type CustomRange = {
+    gte?: string;
+    lte?: string;
+};
+/**
+ * `MetricRequestResponse` is an object with four properties: `value`, `min`, `max`, and `comparison`.
+ *
+ * The `value` property is a number. The `min` and `max` properties are also numbers. The `comparison`
+ * property is a number.
+ * @property {number} value - The value of the metric
+ * @property {number} min - The minimum value of the metric
+ * @property {number} max - The maximum value of the metric
+ * @property {number} comparison - The value of the metric for the previous period.
+ */
+export declare type MetricRequestResponse = {
+    value: number;
+    min: number;
+    max: number;
+    comparison: number;
+};
+export declare type MetricPeriod = RelativeDateConfig;
+export declare type MetricComparison = RelativeDateConfig;
+export declare type MetricConfig = {
+    logic: IFBLogic[];
+    data: MetricConfigData;
+};
+export declare type MetricConfigData = {
+    dateColumn: IBColumn;
+    timePeriod: MetricTimeInfo;
+    timePeriodCustomRange: MetricTimeCustomRange;
+    timePeriodDate: string;
+    timePeriodEndDate: string;
+    comparison: MetricTimeInfo;
+    comparisonCustomRange: MetricTimeCustomRange;
+    comparisonDate: string;
+    comparisonEndDate: string;
+    value: {
+        id: string;
+        property: string;
+    };
+    valueAggregate: {
+        label: AGGREGATE_LABEL;
+    };
+};
+export declare type MetricTimeCustomRange = {
+    key: string;
+    label: TP_CUSTOM_RANGE;
+    text: string;
+};
+export declare type MetricTimeInfo = {
+    key: string;
+    label: TimePeriod;
+    text: string;
+};

package/dist/charts/interfaces/IRequestAdapterMetric.js

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

package/dist/charts/interfaces/index.d.ts

@@ -2,3 +2,4 @@ export * from "./IAggregateAbbreviation";
 export * from "./IAggregateInfo";
 export * from "./IAggregateLabel";
 export * from "./IAggregateType";
+export * from "./IRequestAdapterMetric";

package/dist/charts/interfaces/index.js

@@ -2,3 +2,4 @@ export * from "./IAggregateAbbreviation";
 export * from "./IAggregateInfo";
 export * from "./IAggregateLabel";
 export * from "./IAggregateType";
+export * from "./IRequestAdapterMetric";

package/dist/cjs/charts/adapters/RequestAdapterMetric.d.ts

@@ -0,0 +1,7 @@
+import { MetricConfig, MetricRequestPayload } from "../interfaces/IRequestAdapterMetric";
+/**
+ * It takes a metric object and returns a metric request object
+ * @param {MetricConfig} metricObj - MetricConfigData
+ * @returns A function that takes in a metricObj and returns a partial metricRequest
+ */
+export declare const makeBodyRequestMetrics: (metricObj: MetricConfig) => Partial<MetricRequestPayload>;

package/dist/cjs/charts/adapters/RequestAdapterMetric.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBodyRequestMetrics = void 0;
+const general_1 = require("../../general");
+const interfaces_1 = require("../../interfaces");
+const REQUEST_ADAPTER_1 = require("../constants/REQUEST_ADAPTER");
+/**
+ * It takes a metric object and returns a metric request object
+ * @param {MetricConfig} metricObj - MetricConfigData
+ * @returns A function that takes in a metricObj and returns a partial metricRequest
+ */
+const makeBodyRequestMetrics = (metricObj) => {
+    const body = {};
+    const data = metricObj.data;
+    body.logic = getFilterLogic(metricObj);
+    body.value = metricMakeValue(data);
+    /* Checking if the data object has a dateColumn property. If it does, it will add a period and
+      comparison property to the body object. */
+    if (isComparison(data)) {
+        body.period = metricMakeTimeData(data.dateColumn, data.timePeriod, getRangeDataPeriod(data));
+        body.comparison = metricMakeTimeData(data.dateColumn, data.comparison, getRangeDataComparison(data));
+    }
+    return body;
+};
+exports.makeBodyRequestMetrics = makeBodyRequestMetrics;
+/**
+ * If data is truthy, return data.logic, otherwise return an empty array.
+ * @param filters - The data object that is passed to the component.
+ */
+const getFilterLogic = (filters) => (filters === null || filters === void 0 ? void 0 : filters.logic) || [];
+/**
+ * It takes a data object and returns a MetricValue object
+ * @param data - The data object that is passed to the component.
+ * @returns A metric value object
+ */
+const metricMakeValue = (data) => {
+    var _a, _b, _c;
+    return {
+        questionid: (_a = data === null || data === void 0 ? void 0 : data.value) === null || _a === void 0 ? void 0 : _a.id,
+        aggregate: (_b = data === null || data === void 0 ? void 0 : data.valueAggregate) === null || _b === void 0 ? void 0 : _b.label,
+        property: ((_c = data === null || data === void 0 ? void 0 : data.value) === null || _c === void 0 ? void 0 : _c.property) || null,
+    };
+};
+/**
+ * If data is truthy and data.dateColumn is truthy, return true, otherwise return false.
+ * @param data - The data object that is passed to the component.
+ */
+const isComparison = (data) => Boolean(data === null || data === void 0 ? void 0 : data.dateColumn);
+/**
+ * It takes a date column, time data, and a custom range config and returns a metric period or metric
+ * custom range
+ * @param dateColumn - The column that contains the date data.
+ * @param timeData - {
+ * @param {CustomRangeConfig} range - CustomRangeConfig
+ * @returns An object with the following properties:
+ *   - label
+ *   - value
+ *   - questionid
+ */
+const metricMakeTimeData = (dateColumn, timeData, range) => {
+    const relativObject = getConfigRelativeObjectBytimeLabel(timeData.label, range);
+    if (!(0, general_1.isEmpty)(relativObject))
+        return Object.assign(Object.assign({}, relativObject), { questionid: dateColumn.id });
+};
+/**
+ * Given a time label and a custom range, return a relative date config or a metric custom range.
+ * @param {TIME_PERIOD} timeLabel - TIME_PERIOD.CUSTOM_RANGE
+ * @param {CustomRangeConfig} range - CustomRangeConfig
+ * @returns A relative date config or a metric custom range
+ */
+const getConfigRelativeObjectBytimeLabel = (timeLabel, range) => {
+    if (timeLabel === interfaces_1.TIME_PERIOD.CUSTOM_RANGE) {
+        const rangeResults = makeCustomRangeConfig(range);
+        if (!(0, general_1.isEmpty)(rangeResults))
+            return { customRange: rangeResults };
+    }
+    return REQUEST_ADAPTER_1.RELATIVE_OBJECT_BY_TIME_LABEL[timeLabel];
+};
+/**
+ * It takes in a custom range config object and returns a custom range object
+ * @param {CustomRangeConfig} customRangeData - CustomRangeConfig
+ * @returns A function that takes in a customRangeData object and returns a customRange object.
+ */
+const makeCustomRangeConfig = (customRangeData) => {
+    const { endDate, startingDate, label } = customRangeData;
+    if (label === interfaces_1.TP_CUSTOM_RANGE.AFTER && !(0, general_1.isEmpty)(startingDate))
+        return { gte: startingDate };
+    if (label === interfaces_1.TP_CUSTOM_RANGE.BEFORE && !(0, general_1.isEmpty)(startingDate))
+        return { lte: startingDate };
+    if (!(0, general_1.isEmpty)(startingDate) && !(0, general_1.isEmpty)(endDate))
+        return { gte: startingDate, lte: endDate };
+};
+/**
+ * It takes in a metricData object and returns a CustomRangeConfig object
+ * @param metricData - The metric data object that is returned from the API.
+ * @returns An object with the following properties:
+ * startingDate: metricData?.timePeriodDate,
+ * endDate: metricData?.timePeriodEndDate,
+ * label: metricData?.timePeriodCustomRange?.label,
+ */
+const getRangeDataPeriod = (metricData) => {
+    var _a;
+    return {
+        startingDate: metricData === null || metricData === void 0 ? void 0 : metricData.timePeriodDate,
+        endDate: metricData === null || metricData === void 0 ? void 0 : metricData.timePeriodEndDate,
+        label: (_a = metricData === null || metricData === void 0 ? void 0 : metricData.timePeriodCustomRange) === null || _a === void 0 ? void 0 : _a.label,
+    };
+};
+/**
+ * It takes in a metricData object and returns a CustomRangeConfig object
+ * @param metricData - The metric data object that is returned from the API.
+ * @returns An object with the following properties:
+ * startingDate: metricData?.comparisonDate,
+ * endDate: metricData?.comparisonEndDate,
+ * label: metricData?.comparisonCustomRange?.label,
+ */
+const getRangeDataComparison = (metricData) => {
+    var _a;
+    return {
+        startingDate: metricData === null || metricData === void 0 ? void 0 : metricData.comparisonDate,
+        endDate: metricData === null || metricData === void 0 ? void 0 : metricData.comparisonEndDate,
+        label: (_a = metricData === null || metricData === void 0 ? void 0 : metricData.comparisonCustomRange) === null || _a === void 0 ? void 0 : _a.label,
+    };
+};

package/dist/cjs/charts/adapters/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./endpointDataValidators";
 export * from "./endpointDataGet";
 export * from "./endpointData";
+export * from "./RequestAdapterMetric";

package/dist/cjs/charts/adapters/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./endpointDataValidators"), exports);
 __exportStar(require("./endpointDataGet"), exports);
 __exportStar(require("./endpointData"), exports);
+__exportStar(require("./RequestAdapterMetric"), exports);