chore: address pr comments

medusajs · Apr 6, 2023 · d86d60f · d86d60f
1 parent 68ec1ff
commit d86d60f
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 9 deletions.
diff --git a/.changeset/healthy-garlics-retire.md b/.changeset/healthy-garlics-retire.md
@@ -1,5 +1,6 @@
 ---
 "@medusajs/medusa": patch
+"@medusajs/utils": patch
 ---
 
-chore(medusa): rename buildLegacyFieldsListFrom to objectToStringPath
+chore(medusa, utils): rename buildLegacyFieldsListFrom to objectToStringPath
diff --git a/packages/medusa/src/repositories/customer-group.ts b/packages/medusa/src/repositories/customer-group.ts
@@ -13,7 +13,7 @@ import {
   queryEntityWithIds,
   queryEntityWithoutRelations,
 } from "../utils/repository"
-import { objectToStringPath } from "../utils"
+import { objectToStringPath } from "@medusajs/utils"
 import { dataSource } from "../loaders/database"
 
 export type DefaultWithoutRelations = Omit<

diff --git a/packages/medusa/src/repositories/order.ts b/packages/medusa/src/repositories/order.ts
@@ -1,7 +1,7 @@
 import { flatten, groupBy, map, merge } from "lodash"
 import { FindManyOptions, FindOptionsRelations, In } from "typeorm"
 import { Order } from "../models"
-import { objectToStringPath } from "../utils"
+import { objectToStringPath } from "@medusajs/utils"
 import { dataSource } from "../loaders/database"
 
 const ITEMS_REL_NAME = "items"

diff --git a/packages/medusa/src/repositories/product-category.ts b/packages/medusa/src/repositories/product-category.ts
@@ -9,7 +9,7 @@ import {
 import { ProductCategory } from "../models/product-category"
 import { ExtendedFindConfig, QuerySelector } from "../types/common"
 import { dataSource } from "../loaders/database"
-import { objectToStringPath } from "../utils"
+import { objectToStringPath } from "@medusajs/utils"
 import { isEmpty } from "lodash"
 
 export const ProductCategoryRepository = dataSource

diff --git a/packages/medusa/src/repositories/product.ts b/packages/medusa/src/repositories/product.ts
@@ -10,10 +10,10 @@ import { ExtendedFindConfig } from "../types/common"
 import { dataSource } from "../loaders/database"
 import { ProductFilterOptions } from "../types/product"
 import {
-  objectToStringPath,
   isObject,
   fetchCategoryDescendantsIds,
 } from "../utils"
+import { objectToStringPath } from "@medusajs/utils"
 
 export const ProductRepository = dataSource.getRepository(Product).extend({
   async bulkAddToCollection(

diff --git a/packages/medusa/src/repositories/tax-rate.ts b/packages/medusa/src/repositories/tax-rate.ts
@@ -16,7 +16,7 @@ import {
 } from "../models"
 import { TaxRateListByConfig } from "../types/tax-rate"
 import { isDefined } from "medusa-core-utils"
-import { objectToStringPath } from "../utils"
+import { objectToStringPath } from "@medusajs/utils"
 import { dataSource } from "../loaders/database"
 
 const resolveableFields = [

diff --git a/packages/medusa/src/utils/build-query.ts b/packages/medusa/src/utils/build-query.ts
@@ -139,6 +139,7 @@ function buildWhere<TWhereKeys extends object, TEntity>(
 
 /**
  * Revert new object structure of find options to the legacy structure of previous version
+ * @deprecated in favor of import { objectToStringPath } from "@medusajs/utils"
  * @example
  * input: {
  *   test: {
@@ -153,7 +154,7 @@ function buildWhere<TWhereKeys extends object, TEntity>(
  * output: ['test.test1', 'test.test2', 'test.test3.test4', 'test2']
  * @param input
  */
-export function objectToStringPath<TEntity>(
+export function buildLegacyFieldsListFrom<TEntity>(
   input:
     | FindOptionsWhere<TEntity>
     | FindOptionsSelect<TEntity>
@@ -168,7 +169,7 @@ export function objectToStringPath<TEntity>(
 
   for (const key of Object.keys(input)) {
     if (input[key] != undefined && typeof input[key] === "object") {
-      const deepRes = objectToStringPath(input[key])
+      const deepRes = buildLegacyFieldsListFrom(input[key])
 
       const items = deepRes.reduce((acc, val) => {
         acc.push(`${key}.${val}`)

diff --git a/packages/utils/src/common/build-query.ts b/packages/utils/src/common/build-query.ts
@@ -138,7 +138,8 @@ function buildWhere<TWhereKeys extends object, TEntity>(
 }
 
 /**
- * Revert new object structure of find options to the legacy structure of previous version
+ * Converts a typeorms structure of find options to an
+ * array of string paths
  * @example
  * input: {
  *   test: {