types restructure

Author: KSDaemon

packages/cubejs-api-gateway/src/helpers/prepareAnnotation.ts

@@ -154,6 +154,7 @@ function prepareAnnotation(metaConfig: MetaConfig[], query: any) {
 export default prepareAnnotation;
 export {
   ConfigItem,
+  GranularityMeta,
   annotation,
   prepareAnnotation,
 };

packages/cubejs-api-gateway/src/helpers/transformData.ts

@@ -12,19 +12,14 @@ import { ConfigItem } from './prepareAnnotation';
 import { NormalizedQuery, QueryTimeDimension } from '../types/query';
 import { QueryType, ResultType, } from '../types/strings';
 import { QueryType as QueryTypeEnum, ResultType as ResultTypeEnum, } from '../types/enums';
-import { DBResponsePrimitive, DBResponseValue } from '../types/responses';
+import { AliasToMemberMap, DBResponsePrimitive, DBResponseValue, TransformDataResponse } from '../types/responses';
 
 const COMPARE_DATE_RANGE_FIELD = 'compareDateRange';
 const COMPARE_DATE_RANGE_SEPARATOR = ' - ';
 const BLENDING_QUERY_KEY_PREFIX = 'time.';
 const BLENDING_QUERY_RES_SEPARATOR = '.';
 const MEMBER_SEPARATOR = '.';
 
-/**
- * SQL aliases to cube properties hash map.
- */
-type AliasToMemberMap = { [alias: string]: string };
-
 /**
  * Parse date range value from time dimension.
  * @internal
@@ -311,12 +306,7 @@ function transformData(
   query: NormalizedQuery,
   queryType: QueryType,
   resType?: ResultType
-): {
-  members: string[],
-  dataset: DBResponsePrimitive[][]
-} | {
-  [member: string]: DBResponsePrimitive
-}[] {
+): TransformDataResponse {
   const d = data as { [sqlAlias: string]: DBResponseValue }[];
   const membersToAliasMap = getMembers(
     queryType,
@@ -364,7 +354,6 @@ function transformData(
 
 export default transformData;
 export {
-  AliasToMemberMap,
   COMPARE_DATE_RANGE_FIELD,
   COMPARE_DATE_RANGE_SEPARATOR,
   BLENDING_QUERY_KEY_PREFIX,

packages/cubejs-api-gateway/src/interfaces.ts

@@ -10,6 +10,7 @@ import {
 
 import {
   QueryType,
+  ResultType,
 } from './types/enums';
 
 import {
@@ -43,9 +44,24 @@ import {
   QueryRequest
 } from './types/request';
 
+import {
+  AliasToMemberMap,
+  TransformDataResponse
+} from './types/responses';
+
+import {
+  ConfigItem,
+  GranularityMeta
+} from './helpers/prepareAnnotation';
+
 export {
+  AliasToMemberMap,
+  TransformDataResponse,
+  ConfigItem,
+  GranularityMeta,
   QueryTimeDimensionGranularity,
   QueryType,
+  ResultType,
   QueryFilter,
   LogicalAndFilter,
   LogicalOrFilter,

packages/cubejs-api-gateway/src/types/responses.ts

@@ -1,6 +1,3 @@
-/**
- * Query 'or'-filters type definition.
- */
 export type DBResponsePrimitive =
   null |
   boolean |
@@ -18,3 +15,8 @@ export type TransformDataResponse = {
 } | {
   [member: string]: DBResponsePrimitive
 }[];
+
+/**
+ * SQL aliases to cube properties hash map.
+ */
+export type AliasToMemberMap = { [alias: string]: string };

packages/cubejs-backend-native/js/index.ts

@@ -3,6 +3,14 @@ import fs from 'fs';
 import path from 'path';
 import { Writable } from 'stream';
 import type { Request as ExpressRequest } from 'express';
+import type {
+  AliasToMemberMap,
+  TransformDataResponse,
+  NormalizedQuery,
+  QueryType,
+  ResultType,
+  ConfigItem,
+} from '@cubejs-backend/api-gateway';
 import { CubeStoreResultWrapper } from './CubeStoreResultWrapper';
 
 export * from './CubeStoreResultWrapper';
@@ -101,6 +109,15 @@ export type SQLInterfaceOptions = {
   gatewayPort?: number,
 };
 
+export type TransformDataRequest = {
+  aliasToMemberNameMap: AliasToMemberMap,
+  annotation: { [member: string]: ConfigItem },
+  data: { [sqlAlias: string]: unknown }[],
+  query: NormalizedQuery,
+  queryType: QueryType,
+  resType?: ResultType
+};
+
 export function loadNative() {
   // Development version
   if (fs.existsSync(path.join(__dirname, '/../../index.node'))) {
@@ -366,6 +383,12 @@ export const getCubestoreResult = (ref: CubeStoreResultWrapper): ResultRow[] =>
   return native.getCubestoreResult(ref);
 };
 
+export const transformData = (data: TransformDataRequest): TransformDataResponse => {
+  const native = loadNative();
+
+  return native.transformQueryData(data);
+};
+
 export interface PyConfiguration {
   repositoryFactory?: (ctx: unknown) => Promise<unknown>,
   logger?: (msg: string, params: Record<string, any>) => void,