Class CategoryDataService

constructor

• new CategoryDataService(db): CategoryDataService

• Parameters

  • db: Db

  Returns CategoryDataService

createCategory

• createCategory(category): Promise<{
      id: string;
  }>

• Create category into database

  Parameters

  • category: CreateCategoryDto

  Returns Promise<{
      id: string;
  }>

  Promise<{id: string}> id of created category record

deleteCategory

• deleteCategory(id): Promise<boolean>

• Delete category from database by Id Process of deleting a category:

  • Confirm if category in database, if not, throw not found error
  • Update the records, with category id inside the ancestors, pull categoryId from ancestors
  • Update the records, with parentId = categoryToDelete.id, set parentId=categoryToDelete.parentId If category tree looks like A-B-C-D-E, after delete B, it will become A-C-D-E If category tree looks like A-B, after delete A, it will become B

  Parameters

  • id: string

  Returns Promise<boolean>

doesCategoryExist

• doesCategoryExist(id): Promise<boolean>

• Check if category exist in database

  Parameters

  • id: string

    id of category to query

  Returns Promise<boolean>

  true if category exist, false if category not found

getCategory

• getCategory(id): Promise<null | CategoryEntity>

• Get category from database

  Parameters

  • id: string

  Returns Promise<null | CategoryEntity>

  Promise<Category | undefined> Category data if fetched successfully, or null if data not found by id

getCategoryTree

• getCategoryTree(parentId, orderParams, paginationOptions): Promise<PaginatedFindResult<CategoryTree>>

• Return two layer category tree. category object with a children property, which is a categoryList

  Parameters

  • parentId: string

    parentId of a categoryTreeList

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<PaginatedFindResult<CategoryTree>>

  categoryTree blocks-6a17

listPaginatedCategories

• listPaginatedCategories(opts): Promise<PaginatedFindResult<CategoryEntity>>

• List paginated categories

  Parameters

  • opts: ParsedPaginatedListQuery

    paginated list query options

  Returns Promise<PaginatedFindResult<CategoryEntity>>

  paginated category list query result

normalizeCategoryResponse

• normalizeCategoryResponse(category): Promise<CategoryResponse>

• Normalize category to response format

  Parameters

  • category: Category

  Returns Promise<CategoryResponse>

  CategoryResponse which aligns with the API docs format to return to frontend

normalizeCategoryResponses

• normalizeCategoryResponses(categories): Promise<CategoryResponse[]>

• Normalize list of category responses

  Parameters

  • categories: Category[]

    category models

  Returns Promise<CategoryResponse[]>

normalizeCategoryTreeResponse

• normalizeCategoryTreeResponse(category): Promise<CategoryTreeResponse>

• Normalize category tree to response format

  Parameters

  • category: CategoryTree

  Returns Promise<CategoryTreeResponse>

  CategoryResponse which aligns with the API docs format to return to frontend blocks-404c

normalizeCategoryTreeResponses

• normalizeCategoryTreeResponses(categories): Promise<CategoryTreeResponse[]>

• Normalize list of category tree responses

  Parameters

  • categories: CategoryTree[]

    category models

  Returns Promise<CategoryTreeResponse[]>

updateCategory

• updateCategory(id, categoryInfo): Promise<{
      id: string;
  }>

• Update category data. If category parentId is updated, all the location have this category id in path, will get updated.

  Parameters

  • id: string

    blocks-9132

  • categoryInfo: Partial<Omit<Category, "id">>

  Returns Promise<{
      id: string;
  }>

Static Readonly COLLECTION_CATEGORY