feat: add flatten function for inlcluded referenced entities

Author: Olivier Costi

src/generator/01-base/static/queriesWithFilter.ts.txt

@@ -37,7 +37,7 @@ export type CountQuery<F> = {
 
 export type SomeQuery<E, F, I, P> = {
   serializeNulls?: boolean;
-  include?: QuerySelect<I>;
+  include?: QuerySelectIncludedReferences<I>;
   properties?: P;
   filter?: QueryFilter<F> & CustomAttributeFilter;
   select?: QuerySelect<E>;
@@ -171,7 +171,7 @@ const _some = (
       serializeNulls: query?.serializeNulls,
       additionalProperties: query?.properties?.join(','),
       properties: query?.select ? flattenSelect(query.select).join(',') : undefined,
-      includeReferencedEntities: query?.include ? Object.keys(query.include).join(',') : undefined,
+      includeReferencedEntities: query?.include ? flattenIncludedReferences(query.include).join(',') : undefined,
       ...flattenOrFilter(query?.or),
       ...flattenFilter(query?.filter),
       ...flattenSort(query?.sort),

src/generator/01-base/static/queriesWithQueryLanguage.ts.txt

@@ -47,7 +47,7 @@ export type CountQuery<F> = {
 
 export type SomeQuery<E, F, I, P> = {
   serializeNulls?: boolean;
-  include?: QuerySelect<I>;
+  include?: QuerySelectIncludedReferences<I>;
   properties?: P;
   where?: QueryFilter<F>;
   select?: QuerySelect<E>;
@@ -234,7 +234,7 @@ const _some = (
         ? flattenSelect(query.select).join(',')
         : undefined,
       includeReferencedEntities: query?.include
-        ? Object.keys(query.include).join(',')
+        ? flattenIncludedReferences(query.include).join(',')
         : undefined,
       ...assembleFilterParam(query?.where),
       ...flattenSort(query?.sort),

src/generator/01-base/static/types.ts.txt

@@ -30,6 +30,14 @@ export type QuerySelect<T> = {
       : boolean;
 };
 
+export type QuerySelectIncludedReferences<T> = {
+  [P in keyof T]?: T[P] extends Array<infer U> | undefined
+    ? QuerySelectIncludedReferences<U>
+    : T[P] extends Record<any, any> | undefined
+      ? QuerySelectIncludedReferences<T[P]>
+      : boolean;
+};
+
 export type Select<T, Q extends QuerySelect<T> | undefined> =
   Q extends QuerySelect<T>
     ? {

src/generator/01-base/static/utils.ts.txt

@@ -12,6 +12,22 @@ const flattenSelect = (obj: Select<any, any> = {}): string[] => {
   return entries;
 };
 
+const flattenIncludedReferences = (obj: QuerySelectIncludedReferences<any> = {}, base = ''): string[] => {
+  const entries: string[] = [];
+
+  for (const [prop, value] of Object.entries(obj)) {
+    const path = base ? `${base}.${prop}` : prop;
+
+    if (typeof value === 'object' && value) {
+      entries.push(...flattenIncludedReferences(value as QuerySelectIncludedReferences<any>, path));
+    } else if (value) {
+      entries.push(path);
+    }
+  }
+
+  return entries;
+};
+
 export const flattenSort = (obj: Sort<any>[] = []): { sort?: string } => {
   const flatten = (obj: Sort<any>, base = ''): string | undefined => {
     const [key, value] = Object.entries(obj ?? {})[0] ?? [];

src/generator/04-services/endpoints/some.ts

@@ -98,8 +98,6 @@ const resolveArrayReferenceProperties = (
   return properties;
 };
 
-// TODO: check v1 and v2
-// TODO: remove boolean from arrays in QuerySelect
 const resolveReferences = (entity: string, entities: Map<string, GeneratedEntity>) => {
   const references: InterfaceProperty[] = [];
   const generatedEntity = entities.get(entity);