feat(medusa, admin-ui): add description field to product categories (#3768)

* feat(medusa): add description field to product categories

* chore: set nullable to false

* chore: added UI for description

* chore: added codegen files

packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts

@@ -103,6 +103,9 @@ export default async (req: Request, res: Response) => {
  *   name:
  *     type: string
  *     description: The name to identify the Product Category by.
+ *   description:
+ *     type: string
+ *     description: An optional text field to describe the Product Category by.
  *   handle:
  *     type: string
  *     description: An optional handle to be used in slugs, if none is provided we will kebab-case the title.

packages/medusa/src/api/routes/admin/product-categories/index.ts

@@ -141,6 +141,7 @@ export const allowedAdminProductCategoryRelations = [
 export const defaultProductCategoryFields = [
   "id",
   "name",
+  "description",
   "handle",
   "is_active",
   "is_internal",

packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts

@@ -103,6 +103,9 @@ export default async (req: Request, res: Response) => {
  *   name:
  *     type: string
  *     description:  The name to identify the Product Category by.
+ *   description:
+ *     type: string
+ *     description: An optional text field to describe the Product Category by.
  *   handle:
  *     type: string
  *     description:  A handle to be used in slugs.

packages/medusa/src/api/routes/store/product-categories/index.ts

@@ -54,6 +54,7 @@ export const defaultStoreCategoryScope = {
 export const defaultStoreProductCategoryFields = [
   "id",
   "name",
+  "description",
   "handle",
   "parent_category_id",
   "created_at",
@@ -64,6 +65,7 @@ export const defaultStoreProductCategoryFields = [
 export const allowedStoreProductCategoryFields = [
   "id",
   "name",
+  "description",
   "handle",
   "parent_category_id",
   "created_at",

packages/medusa/src/migrations/1680857773272-add-description-to-product-category.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+
+export class addDescriptionToProductCategory1680857773272 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "product_category" ADD COLUMN IF NOT EXISTS "description" TEXT NOT NULL DEFAULT ''`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "product_category" DROP COLUMN IF EXISTS "description"`
+    )
+  }
+}

packages/medusa/src/models/product-category.ts

@@ -25,6 +25,9 @@ export class ProductCategory extends BaseEntity {
   @Column()
   name: string
 
+  @Column({ nullable: false, default: '' })
+  description: string
+
   @Index({ unique: true })
   @Column({ nullable: false })
   handle: string

packages/medusa/src/types/product-category.ts

@@ -1,5 +1,12 @@
 import { Transform } from "class-transformer"
-import { IsNotEmpty, IsOptional, IsString, IsBoolean } from "class-validator"
+import {
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  IsBoolean,
+  ValidateIf,
+} from "class-validator"
+import { isDefined } from "medusa-core-utils"
 import { ProductCategory } from "../models"
 
 export const tempReorderRank = 99999
@@ -21,6 +28,11 @@ export type UpdateProductCategoryInput = ProductCategoryInput & {
 }
 
 export class AdminProductCategoriesReqBase {
+  @Transform(({ value }) => (value === "null" ? null : value))
+  @ValidateIf((input) => isDefined(input.description))
+  @IsString()
+  description?: string
+
   @IsOptional()
   @IsString()
   handle?: string