@general-dexterity/cube-records
Version:
Opinionated wrapper around @cubejs-client/react
95 lines • 2.8 kB
JavaScript
// src/use-cube-record-query.ts
import {
useCubeQuery as useCoreCubeQuery
} from "@cubejs-client/react";
var formatFilters = (filters, cubeRecordName) => {
return filters.map((filter) => {
const member = filter.member.includes(".") ? filter.member : `${cubeRecordName}.${filter.member}`;
if ("values" in filter && filter.values) {
return {
member,
operator: filter.operator,
values: filter.values
};
}
return {
member,
operator: filter.operator
};
});
};
var formatResultSet = (resultSet, cubeRecordName, strip) => {
if (!resultSet) {
return [];
}
const data = resultSet.tablePivot();
if (!strip) {
return data;
}
return data.map((row) => {
const formattedRow = {};
for (const key in row) {
if (Object.hasOwn(row, key)) {
const cleanKey = key.startsWith(`${cubeRecordName}.`) ? key.substring(cubeRecordName.length + 1) : key;
formattedRow[cleanKey] = row[key];
}
}
return formattedRow;
});
};
function useCubeRecordQuery({
model: cubeRecordName,
query,
options
}) {
const cubeQuery = {
measures: query.measures?.map(
(measure) => measure.includes(".") ? measure : `${cubeRecordName}.${measure}`
),
dimensions: query.dimensions?.map(
(dimension) => dimension.includes(".") ? dimension : `${cubeRecordName}.${dimension}`
),
filters: query.filters ? formatFilters(query.filters, cubeRecordName) : void 0,
segments: query.segments,
timeDimensions: query.timeDimensions?.map((td) => ({
...td,
dimension: td.dimension.includes(".") ? td.dimension : `${cubeRecordName}.${td.dimension}`
})),
limit: query.limit,
offset: query.offset,
order: query.order ? Object.entries(query.order).reduce(
(acc, [key, direction]) => {
const member = key.includes(".") ? key : `${cubeRecordName}.${key}`;
acc[member] = direction;
return acc;
},
{}
) : void 0,
timezone: query.timezone,
renewQuery: query.renewQuery,
ungrouped: query.ungrouped,
total: query.total
};
const hasStripFlag = options != null && Object.hasOwn(options, "stripModelPrefix");
const { stripModelPrefix = true, ...coreOptions } = options ?? {};
const forwardedOptions = hasStripFlag ? coreOptions : options;
const { resultSet, isLoading, error, refetch } = useCoreCubeQuery(
cubeQuery,
forwardedOptions
);
const formattedData = formatResultSet(resultSet, cubeRecordName, stripModelPrefix);
const totalResultCount = resultSet?.totalRows() ?? null;
const data = formattedData;
return {
isLoading,
error,
resultSet,
refetch,
data,
totalResultCount
};
}
export {
useCubeRecordQuery
};
//# sourceMappingURL=index.js.map