feat(json-api-nestjs-microorm): enhance getOne and getAll with transform toggles and additional query params, add relationship loading utility and improve logging

Author: klerick

libs/json-api/json-api-nestjs-microorm/src/lib/orm-helper/index.ts

@@ -1,4 +1,5 @@
 import { EntityKey, EntityMetadata } from '@mikro-orm/core';
+import { Logger } from '@nestjs/common';
 import {
   EntityParam,
   TypeField,
@@ -7,6 +8,7 @@ import {
 import { MicroOrmParam } from '../type';
 import { DEFAULT_ARRAY_TYPE } from '../constants';
 
+
 export const getRelation = <E extends object>(
   entityMetadata: EntityMetadata<E>
 ) =>
@@ -30,6 +32,7 @@ export const getPropsType = <E extends object>(
   entityMetadata: EntityMetadata<E>,
   config: PrepareParams<MicroOrmParam>['options']['arrayType'] = DEFAULT_ARRAY_TYPE
 ): EntityParam<E>['propsType'] => {
+  const logger = new Logger('JSON-API:MkroORM: init');
   const field = getProps(entityMetadata);
 
   const result = {} as any;
@@ -56,6 +59,10 @@ export const getPropsType = <E extends object>(
       case 'object':
         typeProps = TypeField.object;
         break;
+      case 'any':
+        logger.warn(`The field "${item}" in entity ${entityMetadata.name} has runtime type "any". Should be use object type.`);
+        typeProps = TypeField.object;
+        break;
       default:
         typeProps = TypeField.string;
     }

libs/json-api/json-api-nestjs-microorm/src/lib/orm-methods/get-all/get-all.ts

@@ -6,7 +6,8 @@ import { getQueryForCount, getSortObject } from './get-query-for-count';
 
 export async function getAll<E extends object, IdKey extends string>(
   this: MicroOrmService<E, IdKey>,
-  query: Query<E, IdKey>
+  query: Query<E, IdKey>,
+  additionalQueryParams?: Record<string, unknown>
 ): Promise<{
   totalItems: number;
   items: E[];
@@ -18,6 +19,10 @@ export async function getAll<E extends object, IdKey extends string>(
     ReturnType<typeof getQueryForCount<E, IdKey>>
   >(this, ...[query]);
 
+  if (additionalQueryParams) {
+    countSubQuery.andWhere(additionalQueryParams);
+  }
+
   const skip = (page.number - 1) * page.size;
 
   await countSubQuery.applyFilters();

libs/json-api/json-api-nestjs-microorm/src/lib/orm-methods/get-one/get-one.ts

@@ -6,7 +6,8 @@ import { MicroOrmService } from '../../service';
 export async function getOne<E extends object, IdKey extends string>(
   this: MicroOrmService<E, IdKey>,
   id: number | string,
-  query: QueryOne<E, IdKey>
+  query: QueryOne<E, IdKey>,
+  additionalQueryParams?: Record<string, unknown>
 ): Promise<E> {
   const queryBuilder = this.microOrmUtilService.queryBuilder().where({
     [this.microOrmUtilService.currentPrimaryColumn]: id,
@@ -17,6 +18,10 @@ export async function getOne<E extends object, IdKey extends string>(
     query as any
   );
 
+  if (additionalQueryParams) {
+    resultQueryBuilder.andWhere(additionalQueryParams);
+  }
+
   await resultQueryBuilder.applyFilters();
 
   const resultItem = await resultQueryBuilder.getSingleResult();

libs/json-api/json-api-nestjs-microorm/src/lib/service/micro-orm-util.service.ts

@@ -567,7 +567,7 @@ export class MicroOrmUtilService<
     });
   }
 
-  private async *asyncIterateFindRelationships(
+  async *asyncIterateFindRelationships(
     relationships: NonNullable<Relationships<E, IdKey>>
   ): AsyncGenerator<RelationshipsResult<E>> {
     for (const entries of ObjectTyped.entries(relationships)) {

libs/json-api/json-api-nestjs-microorm/src/lib/service/microorm-service.ts

@@ -1,8 +1,10 @@
 import { Inject } from '@nestjs/common';
 import {
+  ObjectTyped,
   QueryField,
   ResourceObject,
   ResourceObjectRelationships,
+  RelationKeys
 } from '@klerick/json-api-nestjs-shared';
 import {
   JsonApiTransformerService,
@@ -27,7 +29,6 @@ import {
   postRelationship,
 } from '../orm-methods';
 import { MicroOrmUtilService } from './micro-orm-util.service';
-import { RelationKeys } from '@klerick/json-api-nestjs-shared';
 
 export class MicroOrmService<E extends object, IdKey extends string = 'id'>
   implements OrmService<E, IdKey>
@@ -41,14 +42,29 @@ export class MicroOrmService<E extends object, IdKey extends string = 'id'>
 
   async getAll(
     query: Query<E, IdKey>
-  ): Promise<ResourceObject<E, 'array', null, IdKey>> {
+  ): Promise<ResourceObject<E, 'array', null, IdKey>>;
+  async getAll(
+    query: Query<E, IdKey>,
+    transformData?: boolean,
+    additionalQueryParams?: Record<string, unknown>
+  ): Promise<ResourceObject<E, 'array', null, IdKey>>;
+  async getAll(
+    query: Query<E, IdKey>,
+    transformData = true,
+    additionalQueryParams?: Record<string, unknown>
+  ): Promise<
+    ResourceObject<E, 'array', null, IdKey> | { totalItems: number; items: E[] }
+  > {
     const { page } = query;
     const { totalItems, items } = await getAll.call<
       MicroOrmService<E, IdKey>,
       Parameters<typeof getAll<E, IdKey>>,
       ReturnType<typeof getAll<E, IdKey>>
-    >(this, query);
+    >(this, query, additionalQueryParams);
 
+    if (!transformData) {
+      return { totalItems, items };
+    }
     const { data, included } = this.jsonApiTransformerService.transformData(
       items,
       query
@@ -70,12 +86,29 @@ export class MicroOrmService<E extends object, IdKey extends string = 'id'>
   async getOne(
     id: number | string,
     query: QueryOne<E, IdKey>
-  ): Promise<ResourceObject<E, 'object', null, IdKey>> {
+  ): Promise<ResourceObject<E, 'object', null, IdKey>>;
+  async getOne(
+    id: number | string,
+    query: QueryOne<E, IdKey>,
+    transformData?: boolean,
+    additionalQueryParams?: Record<string, unknown>
+  ): Promise<ResourceObject<E, 'object', null, IdKey> | E>;
+  async getOne(
+    id: number | string,
+    query: QueryOne<E, IdKey>,
+    transformData = true,
+    additionalQueryParams?: Record<string, unknown>
+  ): Promise<ResourceObject<E, 'object', null, IdKey> | E> {
     const result = await getOne.call<
       MicroOrmService<E, IdKey>,
       Parameters<typeof getOne<E, IdKey>>,
       ReturnType<typeof getOne<E, IdKey>>
-    >(this, id, query);
+    >(this, id, query, additionalQueryParams);
+
+    if (!transformData) {
+      return result;
+    }
+
     const { data, included } = this.jsonApiTransformerService.transformData(
       result,
       query
@@ -226,4 +259,23 @@ export class MicroOrmService<E extends object, IdKey extends string = 'id'>
       data: this.jsonApiTransformerService.transformRel(result, rel),
     };
   }
+
+  async loadRelations(
+    relationships: PatchData<E, IdKey>['relationships'] | PostData<E, IdKey>['relationships']
+  ): Promise<{
+    [K in RelationKeys<E>]: E[K];
+  }> {
+      const result = {} as { [K in RelationKeys<E> ]: E[K]; };
+
+      for await (const item of this.microOrmUtilService.asyncIterateFindRelationships(
+        relationships as any
+      )) {
+        const itemProps = ObjectTyped.entries(item).at(0);
+        if (!itemProps) continue;
+        const [nameProps, data] = itemProps;
+        Reflect.set(result, nameProps, data);
+      }
+
+      return result;
+  }
 }